Create New Persona

Create a new simulation persona.

POST /api/v1/simulation/personas

Create New Persona

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/simulation/personas \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "role": "<string>",
  "behavior_notes": "<string>",
  "agent_id": "<string>",
  "custom_llm_temperature": 123,
  "enabled_tool_ids": [
    "<string>"
  ],
  "user_overrides": {}
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/simulation/personas"

payload = {
    "name": "<string>",
    "description": "<string>",
    "role": "<string>",
    "behavior_notes": "<string>",
    "agent_id": "<string>",
    "custom_llm_temperature": 123,
    "enabled_tool_ids": ["<string>"],
    "user_overrides": {}
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    role: '<string>',
    behavior_notes: '<string>',
    agent_id: '<string>',
    custom_llm_temperature: 123,
    enabled_tool_ids: ['<string>'],
    user_overrides: {}
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/simulation/personas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "<string>",
  "name": "<string>",
  "object": "simulation_persona",
  "description": "<string>",
  "role": "<string>",
  "behavior_notes": "<string>",
  "agent_id": "<string>",
  "agent_name": "<string>",
  "custom_llm_temperature": 123,
  "enabled_tool_ids": [
    "<string>"
  ],
  "user_overrides": {},
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for creating a simulation persona via the v1 API.

name · string · required

description · string | null

role · string | null

behavior_notes · string | null

agent_id · string | null

custom_llm_temperature · number | null

enabled_tool_ids · string[] | null

user_overrides · User Overrides · object | null

Response

201 - application/json

Created

Response schema for simulation personas.

id · string · required

name · string · required

object · string · default: simulation_persona

description · string | null

role · string | null

behavior_notes · string | null

agent_id · string | null

agent_name · string | null

custom_llm_temperature · number | null

enabled_tool_ids · string[] | null

user_overrides · User Overrides · object | null

created_at · string | null

updated_at · string | null