Skip to main content
GET
/
api
/
conversation-flows
/
{conversationFlowId}
Get conversation flow
curl --request GET \
  --url https://api.upon-ai.com/api/conversation-flows/{conversationFlowId} \
  --header 'Authorization: Bearer <token>'
{
  "conversation_flow_id": "<string>",
  "version": 123,
  "start_speaker": "<string>",
  "workspaceId": 123,
  "global_prompt": "<string>",
  "model_choice": {
    "type": "<string>",
    "model": "<string>"
  },
  "nodes": [
    {
      "id": "<string>",
      "type": "<string>",
      "instruction": {
        "type": "<string>",
        "text": "<string>"
      },
      "edges": [
        {
          "id": "<string>",
          "transition_condition": {
            "type": "<string>",
            "prompt": "<string>"
          },
          "destination_node_id": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://documentation.uponai.com/llms.txt

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

Authorizations

Authorization
string
header
required

Generate tokens from your profile settings at app.uponai.com.

Path Parameters

conversationFlowId
string
required

Conversation flow identifier.

Query Parameters

workspaceId
integer
required

Workspace identifier. Call GET /api/workspaces to list workspaces accessible to your token.

version
integer

Specific version to retrieve or update.

Required range: x >= 1

Response

200 - application/json

Conversation flow details.

conversation_flow_id
string
required
version
integer
required
start_speaker
string | null
workspaceId
integer | null
global_prompt
string | null
model_choice
object
nodes
object[]