Check Completion Status

GET/v0/pipelines/{pipeline_name}/completion_status

Authentication

JSON web token (JWT) or API key (http bearer)

Parameters

pipeline_name (path, string, required)

token (query, string, required)

Check the status of a completion token returned by the /ingress or /completion_token endpoint.

Authentication

Scheme	Type	Details
`JSON web token (JWT) or API key`	Bearer token	Authorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

Name	Type	Required	Description
`pipeline_name`	string	Yes	Unique pipeline name

Query parameters

Name	Type	Required	Description
`token`	string	Yes	Completion token returned by the '/ingress' or '/completion_status' endpoint.

Response

application/json

The pipeline has finished processing inputs associated with the provided completion token.

object
Response to a completion token status request.
- statusstringrequired
  Completion token status returned by the `/completion_status` endpoint.
- stepinteger (int64)
  If all of the data associated with the token has been processed through the pipeline, this is the final step that includes at least one record. When the pipeline's `total_completed_steps` reaches this value, the token has been completed. This is `None` before the data associated with the token has been processed through the pipeline.

curl -X GET '/v0/pipelines/{pipeline_name}/completion_status?token=%3Ctoken%3E' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Pipeline with that name does not exist


{
  "message": "Unknown pipeline name 'non-existent-pipeline'",
  "error_code": "UnknownPipelineName",
  "details": {
    "pipeline_name": "non-existent-pipeline"
  }
}