Create persona

POST

/api/v1/personas

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/personas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "display_name": "example", "background": "example", "role_description": "example", "voice_descriptors": [], "quirks": [], "never_says": [], "always_says": [], "sample_phrases": [], "recommended_voice_id": "example", "recommended_conversation_style": { "additionalProperty": "example" } }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 100 characters

display_name

required

string

>= 1 characters <= 200 characters

background

required

string

>= 1 characters <= 4000 characters

role_description

required

string

>= 1 characters <= 4000 characters

voice_descriptors

Array<string>

default:

quirks

Array<string>

default:

never_says

Array<string>

default:

always_says

Array<string>

default:

sample_phrases

Array<string>

default:

recommended_voice_id

Any of:

string

string

>= 1 characters <= 200 characters

null

null

recommended_conversation_style

Any of:

object

object

key

additional properties

null

null

Responses

201

Created

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}