Skip to main content
POST
/
personas
Create persona
curl --request POST \
  --url https://app2.freyavoice.ai/api/v2/personas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "successCriteria": "<string>",
  "tags": [
    "<string>"
  ],
  "agentIds": [
    "<string>"
  ]
}
'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "persona": {
        "id": "<string>",
        "workspaceId": "<string>",
        "name": "<string>",
        "prompt": "<string>",
        "successCriteria": "<string>",
        "tags": [
          "<string>"
        ],
        "agentIds": [
          "<string>"
        ],
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "createdBy": "<string>",
        "updatedBy": "<string>"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
workspaceId
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
prompt
string
Maximum string length: 100000
successCriteria
string
Maximum string length: 100000
tags
string[]
agentIds
string[]

Response

Persona created

success
enum<boolean>
required
Available options:
true,
false
data
object
required