Skip to main content

​
Overview

Personas represent AI characters with specific personality traits, backgrounds, and voice characteristics. They are reusable across multiple scenarios.

​
Get All Personas

Retrieve all personas for the authenticated user.
​
none
​
status
string
Response status
​
data
array
Array of persona objects
curl -X GET https://api.waterrai.com/personas \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "status": "success",
  "data": [
    {
      "id": 123,
      "name": "Sarah Chen",
      "job_title": "Senior Product Manager",
      "demeanor": "friendly",
      "background": "Experienced product manager...",
      "voice_id": 1,
      "avatar": "https://example.com/avatar.jpg",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

​
Get Persona by ID

Retrieve a specific persona by its ID.
​
id
integer
required
The persona ID
curl -X GET https://api.waterrai.com/personas/123 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "Sarah Chen",
    "job_title": "Senior Product Manager",
    "demeanor": "friendly",
    "background": "Experienced product manager with 10 years in tech...",
    "voice_id": 1,
    "avatar": "https://example.com/avatar.jpg",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

​
Create Persona

Create a new persona with specified characteristics.
​
name
string
required
Name of the persona (max 100 characters)
​
job_title
string
required
Job title of the persona (max 100 characters)
​
demeanor
string
Personality style. Options: friendly, analytical, empathetic, curious, enthusiastic, critical, casual, blunt, assertive, neutral
​
background
string
Detailed background information about the persona
​
voice_id
integer
ID of the voice associated with the persona
​
avatar
string
URL or path to the persona’s avatar image (max 255 characters)
curl -X POST https://api.waterrai.com/personas \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sarah Chen",
    "job_title": "Senior Product Manager",
    "demeanor": "friendly",
    "background": "Experienced product manager with 10 years in tech, specializing in user experience and product strategy.",
    "voice_id": 1
  }'

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "Sarah Chen",
    "job_title": "Senior Product Manager",
    "demeanor": "friendly",
    "background": "Experienced product manager...",
    "voice_id": 1,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

​
Update Persona

Update an existing persona.
​
name
string
Name of the persona (max 100 characters)
​
job_title
string
Job title of the persona (max 100 characters)
​
demeanor
string
Personality style
​
background
string
Detailed background information
​
voice_id
integer
ID of the voice associated with the persona
​
avatar
string
URL or path to the persona’s avatar image
​
id
integer
required
The persona ID to update
curl -X PUT https://api.waterrai.com/personas/123 \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sarah Chen",
    "job_title": "VP of Product",
    "demeanor": "analytical"
  }'

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "Sarah Chen",
    "job_title": "VP of Product",
    "demeanor": "analytical",
    "updated_at": "2024-01-15T11:00:00Z"
  }
}

​
Delete Persona

Delete a persona by ID.
​
id
integer
required
The persona ID to delete
curl -X DELETE https://api.waterrai.com/personas/123 \
  -H "Authorization: Bearer YOUR_API_TOKEN"