Update an extraction flow

Partially update an extraction flow. The most common use is to switch its publish mode between auto_publish and manual_publish.

Publish modes:

• auto_publish — Each successful flow run automatically publishes the extracted data. No separate publish step is required.
• manual_publish — Flow runs only compute and persist extracted data in the warehouse. Publishing to downstream indexes must be triggered explicitly via the publish action. Use this when you want to review the results of a run before exposing them to search / agents.

PATCH /projects/{project_id}/extraction-flows/{flow_id}

Update an extraction flow

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/extraction-flows/{flow_id}/"

payload = { "publish_mode": "manual_publish" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "publish_mode": "auto_publish",
  "dag": {},
  "tpuf_namespaces": {},
  "last_pushed_to_tpuf": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

BearerAuthTokenAuth

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

name · string

Human-readable name of the flow

publish_mode · enum<string>

Controls whether extracted data is pushed to downstream indexes automatically after each run (auto_publish) or only on an explicit publish call (manual_publish).

Available options: auto_publish, manual_publish

dag · object

DAG definition (name + nodes) for the extraction flow.

Response

200

application/json

Flow updated successfully

id · string<uuid>

name · string

publish_mode · enum<string>

• auto_publish — runs automatically push extracted data to downstream indexes.
• manual_publish — publishing is triggered explicitly via the publish action.

Available options: auto_publish, manual_publish

dag · object

DAG definition (name + nodes) describing the extractor pipeline.

tpuf_namespaces · object

Per-namespace-type TurboPuffer namespace mapping populated on publish.

last_pushed_to_tpuf · string<date-time> | null

created_at · string<date-time>

updated_at · string<date-time>