Skip to main content
PATCH
/
personalities
/
{personality_id}
Update personality
curl --request PATCH \
  --url https://api.spikelabs.com/v1/personalities/{personality_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "system_prompt": "<string>",
  "voice": {
    "provider": "elevenlabs",
    "voice_id": "<string>",
    "settings": {
      "stability": 0.5,
      "similarity_boost": 0.5,
      "speed": 1.25
    }
  },
  "appearance": {
    "avatar_id": "<string>",
    "style": "realistic",
    "background": "<string>"
  },
  "traits": {
    "warmth": 0.5,
    "humor": 0.5,
    "formality": 0.5,
    "verbosity": 0.5,
    "empathy": 0.5
  },
  "metadata": {}
}
'
{
  "id": "personality_abc123",
  "object": "personality",
  "name": "Luv",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "system_prompt": "<string>",
  "voice": {
    "provider": "elevenlabs",
    "voice_id": "<string>",
    "settings": {
      "stability": 0.5,
      "similarity_boost": 0.5,
      "speed": 1.25
    }
  },
  "appearance": {
    "avatar_id": "<string>",
    "style": "realistic",
    "background": "<string>"
  },
  "traits": {
    "warmth": 0.5,
    "humor": 0.5,
    "formality": 0.5,
    "verbosity": 0.5,
    "empathy": 0.5
  },
  "metadata": {}
}

Authorizations

Authorization
string
header
required

API key authentication. Use your secret key (starts with sk_) as a Bearer token.

Path Parameters

personality_id
string
required

Personality ID (starts with personality_)

Body

application/json
name
string
Maximum string length: 100
description
string
Maximum string length: 500
system_prompt
string
Maximum string length: 10000
voice
object
appearance
object
traits
object

Behavioral trait sliders (0-1)

metadata
object

Response

Personality updated

id
string
required

Unique identifier

Example:

"personality_abc123"

object
enum<string>
required
Available options:
personality
name
string
required

Display name

Example:

"Luv"

created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null

Brief description of the personality

system_prompt
string | null

System prompt that defines behavior

voice
object
appearance
object
traits
object

Behavioral trait sliders (0-1)

metadata
object

Custom key-value metadata