import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/"
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/', 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/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"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_count": 123,
"chunk_count": 123,
"raw_logs": "<string>"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}List pipeline runs
List all pipeline runs in the project, ordered by creation date (most
recent first). Use this to discover the id of a run returned by an
extraction flow run-sync / publish call, or to monitor recent
activity.
The list response uses a lightweight serializer that omits the very
large chunk_ids / document_ids arrays and truncates raw_logs to
the most recent entries. Fetch a single run via the detail endpoint
to get the full payload.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/pipeline-runs/"
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/', 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/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"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_count": 123,
"chunk_count": 123,
"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
Query Parameters
Filter pipeline runs by status (e.g. pending, running, completed, failed).
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 Maximum number of results per page
1 <= x <= 1000Number of results to skip for pagination
x >= 0