Get Completion Token

GET/v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/completion_token

Authentication

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

Parameters

pipeline_name (path, string, required)

table_name (path, string, required)

connector_name (path, string, required)

Generate a completion token for an input connector.

Returns a token that can be passed to the /completion_status endpoint to check whether the pipeline has finished processing all inputs received from the connector before the token was generated.

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
`table_name`	string	Yes	SQL table name. Unquoted SQL names have to be capitalized. Quoted SQL names have to exactly match the case from the SQL program.
`connector_name`	string	Yes	Unique input connector name

Response

application/json

Completion token that can be passed to the '/completion_status' endpoint.

object
Response to a completion token creation request.
- tokenstringrequired
  Completion token. An opaque string associated with the current position in the input stream generated by an input connector. Pass this string to the `/completion_status` endpoint to check whether all inputs associated with the token have been fully processed by the pipeline.

curl -X GET '/v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/completion_token' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Specified pipeline, table, or connector does not exist


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