Skip to main content
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)
{
  "message": "Sync started.",
  "pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

​
project_id
string<uuid>
required

UUID of the project

​
flow_id
string<uuid>
required

UUID of the extraction flow

Body

application/json
​
document_ids
string<uuid>[]

Optional list of document UUIDs to run the flow on. If omitted or empty, the flow runs against all documents in the project.

Response

Sync started

​
message
string
Example:

"Sync started."

​
pipeline_run_id
string<uuid>