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>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

conversationFlowId
string
required

Conversation flow identifier.

Query Parameters

workspaceId
integer
required

Workspace identifier.

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[]