Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.burki.dev/llms.txt

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

Conversation Flows are available under /api/v1/flows. They are the current orchestration API for multi-step call routing.

​
Flow Object

{
  "id": 42,
  "organization_id": 1,
  "base_assistant_id": 123,
  "name": "Customer Support Flow",
  "graph": {
    "begin_node": "start",
    "global_prompt": "Be concise.",
    "nodes": {
      "start": {
        "type": "conversation",
        "prompt": "Greet the caller.",
        "transitions": [
          {
            "kind": "prompt",
            "to": "support",
            "when": "The caller needs support."
          }
        ]
      },
      "support": {
        "type": "conversation",
        "prompt": "Help the caller with support questions."
      }
    }
  },
  "is_active": true,
  "created_at": "2026-04-29T14:00:00Z",
  "updated_at": "2026-04-29T14:00:00Z"
}

​
List Flows

Query parameters:
FieldTypeDescription
active_onlybooleanDefaults to true. When true, returns only active flows.
curl "https://api.burki.dev/api/v1/flows?active_only=true" \
  -H "Authorization: Bearer $BURKI_API_KEY"

​
Create Flow

{
  "name": "Customer Support Flow",
  "base_assistant_id": 123,
  "graph": {
    "begin_node": "start",
    "nodes": {
      "start": {
        "type": "conversation",
        "prompt": "Greet the caller and ask how you can help."
      }
    }
  },
  "is_active": true
}
base_assistant_id and graph can be omitted to let the backend create a starter assistant and one-node starter flow.

​
Get Flow

curl https://api.burki.dev/api/v1/flows/42 \
  -H "Authorization: Bearer $BURKI_API_KEY"

​
Update Flow

Send any subset of name, base_assistant_id, graph, and is_active. 
curl -X PUT https://api.burki.dev/api/v1/flows/42 \
  -H "Authorization: Bearer $BURKI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"is_active": false}'

​
Delete Flow

Deleting a flow removes the flow record and clears phone-number assignments through database foreign keys.

​
Assign Phone Number

Assigns a phone number to a flow and clears any direct assistant assignment. 
curl -X POST https://api.burki.dev/api/v1/flows/42/phone-numbers/7/assign \
  -H "Authorization: Bearer $BURKI_API_KEY"

​
Unassign Phone Number

curl -X POST https://api.burki.dev/api/v1/flows/42/phone-numbers/7/unassign \
  -H "Authorization: Bearer $BURKI_API_KEY"