Skip to main content
POST
Create Profile

Authorizations

Authorization
string
header
required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

agent_id
string
required

Tuner's numeric agent ID, or your Agent ID from Agent Settings > Agent Connection. Digits-only values are read as the numeric ID.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json

Input schema for creating or updating a simulation profile.

name
string
required

Name of the profile, up to 255 characters. Must be unique for the agent.

Required string length: 1 - 255
Example:

"Returning customer"

fields
Fields · object

Facts about the simulated caller, as key-value pairs. Up to 50 keys; each key must match ^[a-zA-Z_][a-zA-Z0-9_]*$ and each value can be up to 1000 characters.

Example:

Response

Successful Response

Response schema for a single simulation profile.

id
integer
required

Profile ID.

agent_id
integer
required

ID of the agent the profile belongs to.

name
string
required

Name of the profile.

fields
Fields · object
required

Facts about the simulated caller, as key-value pairs.

created_at
string<date-time>
required

When the profile was created.

updated_at
string<date-time>
required

When the profile was last updated.