Simulation Personalities

Create Personality

Creates a personality, the AI tester's configuration used in simulations.

Authentication

AuthorizationBearer
Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Headers

x-client-sourcestringOptional
Identifies the product surface making the request
x-simulation-entry-pointstringOptional
Identifies the dashboard simulation flow

Request

This endpoint expects an object.
namestringRequired<=80 characters

The display name of the personality, for example Impatient customer.

assistantobjectRequired

The assistant configuration for the AI tester: the model, voice, and system prompt that determine how the AI tester behaves during the conversation.

pathstring or nullOptionalformat: "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/"<=255 characters

Optional folder path for organizing personalities. Supports up to 3 levels (e.g., “dept/feature/variant”). Maps to GitOps resource folder structure.

Response

idstringformat: "uuid"
This is the unique identifier for the personality.
orgIdstring or nullformat: "uuid"

This is the unique identifier for the organization this personality belongs to. If null, this is a Vapi-provided default personality available to all organizations.

createdAtdatetime

This is the ISO 8601 date-time string of when the personality was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the personality was last updated.

namestring<=80 characters

This is the name of the personality (e.g., “Confused Carl”, “Rude Rob”).

assistantobject
This is the full assistant configuration for this personality. It defines the tester's voice, model, behavior via system prompt, and other settings.
pathstring or nullOptionalformat: "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/"<=255 characters

Optional folder path for organizing personalities. Supports up to 3 levels (e.g., “dept/feature/variant”). Maps to GitOps resource folder structure.