Skip to main content
GET
/
api
/
assistants
List Assistants
curl --request GET \
  --url https://api.userintuition.ai/api/assistants \
  --header 'Authorization: Bearer <token>'
{
  "assistants": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Customer Feedback Assistant",
      "app_id": "user-intuition",
      "voice_config": {
        "voiceId": "alloy",
        "provider": "openai"
      },
      "is_created": true,
      "system_prompt": "You are a customer feedback interviewer...",
      "enable_video_recording": false,
      "enable_chat": false,
      "vapi_assistant_id": "vapi_abc123",
      "study_type": "standard",
      "is_paused": false,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "total_invites": 25,
      "total_calls": 18,
      "excellent_calls": 12,
      "average_duration_seconds": 420.5,
      "user_id": "user_123"
    }
  ],
  "total_count": 1,
  "page": 1,
  "page_size": 100
}

Authorizations

​
Authorization
string
header
required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Query Parameters

​
page
integer
default:1

Page number (default: 1)

Required range: x >= 1
​
page_size
integer
default:100

Items per page (default: 100, max: 1000)

Required range: 1 <= x <= 1000
​
name
string

Filter by assistant name (partial match)

​
app_id
string

Filter by app ID - defaults to user-intuition if not provided

Response

Successful response with list of assistants

​
assistants
object[]
required
​
total_count
integer
required

Total number of assistants

​
page
integer | null

Current page number

​
page_size
integer | null

Number of items per page