Run an extraction flow
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/extraction-flows/{flow_id}/run-sync/"
payload = { "document_ids": ["550e8400-e29b-41d4-a716-446655440000"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_ids: ['550e8400-e29b-41d4-a716-446655440000']})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/extraction-flows/{flow_id}/run-sync/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/extraction-flows/{flow_id}/run-sync/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_ids": [
"550e8400-e29b-41d4-a716-446655440000"
]
}
'{
"message": "Sync started.",
"pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Extraction Flows
Run an extraction flow
Queue a pipeline run that executes the flow’s DAG across the given
documents (or all project documents if document_ids is omitted).
Returns the pipeline_run_id you can poll to track progress.
POST
/
projects
/
{project_id}
/
extraction-flows
/
{flow_id}
/
run-sync
/
Run an extraction flow
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/extraction-flows/{flow_id}/run-sync/"
payload = { "document_ids": ["550e8400-e29b-41d4-a716-446655440000"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document_ids: ['550e8400-e29b-41d4-a716-446655440000']})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/extraction-flows/{flow_id}/run-sync/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/extraction-flows/{flow_id}/run-sync/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document_ids": [
"550e8400-e29b-41d4-a716-446655440000"
]
}
'{
"message": "Sync started.",
"pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer
Path Parameters
UUID of the project
UUID of the extraction flow
Body
application/json
Optional list of document UUIDs to run the flow on. If omitted or empty, the flow runs against all documents in the project.