Ingestion tools - AiQL Docs

Run and manage ingestions inside the session’s workspace. The tools do not take a workspace_id: with OAuth the workspace comes from your access token, and with an API key you pass it in the AiQL-Workspace header. See Workspace scope.

list_ingestions

Lists ingestions in the authenticated workspace.

Parameter	Type	Description
`limit`	`integer`	Optional. Maximum number of items to return per page. Defaults to `20`, maximum `100`. See Pagination.
`cursor`	`string`	Optional. Opaque cursor pointing to the page to fetch. Omit to start from the first page. See Pagination.

create_ingestion

Starts an ingestion that runs the full pipeline and loads the result into the authenticated workspace.

Parameter	Type	Description
`url`	`string`	URL of the file to ingest.

get_ingestion

Retrieves a single ingestion.

Parameter	Type	Description
`id`	`string`	ID of the ingestion to retrieve.

delete_ingestion

Deletes an ingestion.

Parameter	Type	Description
`id`	`string`	ID of the ingestion to delete.

cancel_ingestion

Cancels a running ingestion.

Parameter	Type	Description
`id`	`string`	ID of the ingestion to cancel.

retry_ingestion

Retries a failed ingestion.

Parameter	Type	Description
`id`	`string`	ID of the ingestion to retry.

​list_ingestions

​create_ingestion

​get_ingestion

​delete_ingestion

​cancel_ingestion

​retry_ingestion