Sign in
latestOpenAPI 3.1.0Proprietary2026-08-175035117.5 KB

019f79ecdd6c

SQL

Create a job

Runs a query asynchronously. Use this for queries that would exceed the 1 minute timeout of the synchronous endpoints.

Available for BigQuery, Snowflake, Redshift, PostgreSQL and CARTO Data Warehouse connections.

Poll GET /v3/sql/{connectionName}/job/{jobId} with the returned externalId to follow the execution.

post/v3/sql/{connectionName}/job

Path parameters

connectionNamestring required

Name of the connection to use.

Request body

querystring required

The SQL query, or the name of a named source. Note this field is query, not q.

metadataobject

Arbitrary metadata stored with the job.

Response

The job was created.

externalIdstring

Use this to poll the job.

accountIdstring
userIdstring nullable
connectionIdstring
connectionNamestring
providerIdstring
metadataobject
createdAtstring date-time
querystring
jobMetadataobject

Provider metadata. For workflows executed via API this holds workflowOutputTableName.

tokenstring nullable