import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "pending",
"project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_name": "<string>",
"mode": "<string>",
"celery_task_id": "<string>",
"user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tables": {},
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"step": "<string>",
"name": "<string>",
"status": "pending",
"inputs": {},
"outputs": {},
"warnings": "<unknown>",
"depends_on": [
"<string>"
],
"params": {},
"tag_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chunks_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"chunk_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"raw_logs": "<string>"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Get pipeline run details and status
Retrieve the full details of a single pipeline run, including its
current status, the list of executed steps with their per-step
status, and the aggregated raw_logs produced during execution.
Poll this endpoint to track the progress of a run started via an
extraction flow run-sync or publish call. A run is in a terminal
state when status is one of completed, completed_with_warnings,
failed, or aborted.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/{pipeline_run_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "pending",
"project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pipeline_name": "<string>",
"mode": "<string>",
"celery_task_id": "<string>",
"user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tables": {},
"steps": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"step": "<string>",
"name": "<string>",
"status": "pending",
"inputs": {},
"outputs": {},
"warnings": "<unknown>",
"depends_on": [
"<string>"
],
"params": {},
"tag_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chunks_extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"chunk_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"raw_logs": "<string>"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Path Parameters
UUID of the project
UUID of the pipeline run
Response
Pipeline run details
Full pipeline run payload returned by the detail endpoint.
Lifecycle status of a pipeline run or step:
pending— queued, not yet startedrunning— currently executingcompleted— finished successfullycompleted_with_warnings— finished, but some steps emitted warningsfailed— terminated with an erroraborted— cancelled via theabortaction
pending, running, completed, completed_with_warnings, failed, aborted Run mode (e.g. recreate-all, recreate-single, upsert-single, upsert-all).
ID of the user who triggered the run.
Map of table name → table version UUID for the run.
Show child attributes
Show child attributes
UUIDs of documents this run targets.
UUIDs of chunks this run targets.
Concatenated logs produced during execution.