Skip to main content
GET
/
api
/
v1
/
agents
/
{agent_id}
/
flow
curl "https://app.talkover.ai/api/v1/agents/agent-uuid/flow" \
  -H "Authorization: Bearer talq_your_environment_token_here"
{
  "success": true,
  "data": {
    "conversation_mode": "flow_driven",
    "flow_config": {
      "initial_node_id": "node-greet",
      "meta": {
        "name": "Sales Qualification Flow",
        "version": "1.2.0"
      },
      "nodes": [
        {
          "id": "node-greet",
          "type": "say",
          "content": "Hi! Are you the right person to talk about scheduling?",
          "next": "node-qualify"
        },
        {
          "id": "node-qualify",
          "type": "decision",
          "branches": [
            { "match": "yes", "next": "node-book" },
            { "match": "no", "next": "node-transfer" }
          ]
        }
      ],
      "global_functions": [
        { "name": "end_conversation", "description": "Ends the call gracefully" }
      ]
    }
  }
}

Documentation Index

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

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

Get Agent Flow

Retrieve the agent’s current conversation mode and flow configuration. Agents can run in two modes: llm_driven (default — the LLM steers the conversation freely with knowledge/actions) or flow_driven (a node-based graph dictates the conversation flow).

Endpoint

GET /api/v1/agents/{agent_id}/flow

Path Parameters

agent_id
string
required
Agent UUID.

Request Headers

Authorization
string
required
Bearer token. Format: Bearer talq_your_environment_token_here

Examples

curl "https://app.talkover.ai/api/v1/agents/agent-uuid/flow" \
  -H "Authorization: Bearer talq_your_environment_token_here"

Response

{
  "success": true,
  "data": {
    "conversation_mode": "flow_driven",
    "flow_config": {
      "initial_node_id": "node-greet",
      "meta": {
        "name": "Sales Qualification Flow",
        "version": "1.2.0"
      },
      "nodes": [
        {
          "id": "node-greet",
          "type": "say",
          "content": "Hi! Are you the right person to talk about scheduling?",
          "next": "node-qualify"
        },
        {
          "id": "node-qualify",
          "type": "decision",
          "branches": [
            { "match": "yes", "next": "node-book" },
            { "match": "no", "next": "node-transfer" }
          ]
        }
      ],
      "global_functions": [
        { "name": "end_conversation", "description": "Ends the call gracefully" }
      ]
    }
  }
}

Conversation Modes

  • llm_driven — agent behavior is governed by knowledge, voice, and actions. flow_config is null.
  • flow_driven — a node graph dictates each turn. Use this for highly structured conversations (qualification, intake, scripted outreach).

Notes