Skip to main content
POST
/
api
/
v1
/
explorer
/
queries
/
{query_id}
/
run-async
Execute Query Async
curl --request POST \
  --url https://api.allium.so/api/v1/explorer/queries/{query_id}/run-async \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "parameters": {},
  "run_config": {}
}
'
{
  "run_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.allium.so/llms.txt

Use this file to discover all available pages before exploring further.

Trigger execution of a saved Explorer query. You will need to create a query through the Allium App before calling this endpoint.

​
Key Parameters

  • Parameterized queries - Use the parameters field to specify parameter values when running a parameterized query
  • Row limit - Optionally specify a maximum number of rows to return
  • Compute profile - Optionally specify a compute profile to run the query on

​
Data Export Limit

Maximum Rows: 250,000We currently allow up to 250,000 rows of data to be exported through the API for a single query. This limit can be increased on request and helps prevent mishaps when users forget to add LIMIT clauses to their queries.

​
Next Steps

After creating a new query run:
  1. Poll for its status to check if the query has completed
  2. Retrieve the results when execution is finished

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
query_id
string
required

Body

application/json
​
parameters
Parameters · object
required

Parameter names and values, to be substituted into parameter placeholders in the saved query

​
run_config
Run Config · object

Response

Successful Response

​
run_id
string
required