Render a conversation flow

Serialize a flow-canvas graph into routed CONVERSATION FLOW prompt text (deterministic)

POST /agents/studio/flow/render

Render a conversation flow

cURL

curl --request POST \
  --url https://api.pineyard.ai/agents/studio/flow/render \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flowGraph": {
    "nodes": [
      {
        "id": "<string>",
        "title": "<string>",
        "detail": "<string>"
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "source": "<string>",
        "target": "<string>",
        "condition": "<string>"
      }
    ]
  }
}
'

200

{
  "text": "<string>"
}

Required scope: agents.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

flowGraph · object · required

Show child attributes

agentName · string

Maximum string length: 100

companyName · string

Maximum string length: 120

Response

200

application/json

OK

text · string · required