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)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "publish_mode": "auto_publish",
  "dag": {
    "name": "extraction_flow",
    "nodes": [
      {
        "node_name": "tag_extractor",
        "extractor": "TagExtractor",
        "acceptable_versions": [
          "<string>"
        ],
        "processing_version": "<string>",
        "inputs": {},
        "outputs": {},
        "extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "depends_on": [
          "<string>"
        ],
        "filter_items_type": "<string>",
        "params": {}
      }
    ]
  },
  "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"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

Extraction Flows

Update an extraction flow

Partially update an extraction flow. Common uses are switching the publish mode and editing the DAG (adding, modifying or removing nodes).

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.

Editing the DAG: Send the full updated dag object — the backend replaces the stored DAG on every PATCH. There is no node-level patch endpoint. When removing a node, also strip its name from any downstream depends_on arrays. inputs and outputs may be sent empty; the backend resolves them automatically.

PATCH

projects

{project_id}

extraction-flows

{flow_id}

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)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "publish_mode": "auto_publish",
  "dag": {
    "name": "extraction_flow",
    "nodes": [
      {
        "node_name": "tag_extractor",
        "extractor": "TagExtractor",
        "acceptable_versions": [
          "<string>"
        ],
        "processing_version": "<string>",
        "inputs": {},
        "outputs": {},
        "extractor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "depends_on": [
          "<string>"
        ],
        "filter_items_type": "<string>",
        "params": {}
      }
    ]
  },
  "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"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

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

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 describing the extractor pipeline. PATCH replaces the stored DAG verbatim — there is no node-level patch endpoint.

Show child attributes

Response

Flow updated successfully

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 describing the extractor pipeline. PATCH replaces the stored DAG verbatim — there is no node-level patch endpoint.

Show child attributes

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>

Concepts

Endpoints

Update an extraction flow

Authorizations

Path Parameters

Body

Response