Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

AiQL-Workspace
string
required

ID of the workspace the request operates on.

Path Parameters

id
string
required

Body

application/json
dry_run
boolean
default:false

Run the sync without persisting new/changed documents.

Response

Successful Response

workflow_id
string
required
run_id
string
required
connection_id
string
required
workspace_id
string
required
dry_run
boolean
required
status
string
default:started