Draft a conversation flow with AI

AI-draft the conversation flow, FAQs, and suggested extraction fields for the Studio wizard

POST /agents/studio/draft

Draft a conversation flow with AI

cURL

curl --request POST \
  --url https://api.pineyard.ai/agents/studio/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "goal": "<string>",
  "companyName": "<string>",
  "languages": [
    "<string>"
  ]
}
'

200

{
  "flowGraph": {
    "nodes": [
      {
        "id": "<string>",
        "type": "step",
        "title": "<string>",
        "detail": "<string>"
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "source": "<string>",
        "target": "<string>",
        "condition": "<string>"
      }
    ]
  },
  "flowSteps": [
    {
      "id": "<string>",
      "title": "<string>",
      "detail": "<string>"
    }
  ],
  "faqs": [
    {
      "question": "<string>",
      "answer": "<string>"
    }
  ],
  "openingLine": "<string>",
  "suggestedExtractionKeys": [
    {
      "name": "<string>",
      "type": "string",
      "description": "<string>"
    }
  ],
  "keyTerms": [
    "<string>"
  ],
  "aiUsed": true,
  "cached": true
}

Required scope: agents.edit

Requires the agent_studio feature enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

goal · string · required

Required string length: 1 - 2000

companyName · string · required

Required string length: 1 - 120

languages · string[] · required

Required array length: 1 - 24 elements

Required string length: 1 - 40

tone · enum<string> · required

Available options: warm_professional, formal, casual, assertive, empathetic

companyDescription · string

Maximum string length: 4000

industry · string

Maximum string length: 100

designation · string

Maximum string length: 100

agentName · string

Maximum string length: 100

briefText · string

Maximum string length: 8000

primaryLanguage · string

Required string length: 1 - 40

parts · enum<string>[]

Minimum array length: 1

Available options: flow, faqs, opening

revision · object

Show child attributes

Response

200

application/json

OK

flowGraph · object · required

Show child attributes

flowSteps · object[] · required

Show child attributes

faqs · object[] · required

Show child attributes

openingLine · string · required

suggestedExtractionKeys · object[] · required

Show child attributes

keyTerms · string[] · required

aiUsed · boolean · required

cached · boolean · required