Skip to main content
GET
/
api
/
calls
/
{call_id}
Get Call
curl --request GET \
  --url https://api.userintuition.ai/api/calls/{call_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "call_id": "<string>",
  "assistant_id": "<string>",
  "invite_id": "<string>",
  "user_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "app_id": "<string>",
  "transcript": "<string>",
  "messages": [
    {}
  ],
  "status": "<string>",
  "success_evaluation": "<string>",
  "success_evaluation_details": {},
  "ended_reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "recording_url": "<string>",
  "video_recording_url": "<string>",
  "analysis": {},
  "additional_info": {},
  "original_transcript": "<string>",
  "original_messages": [
    {}
  ],
  "is_visible": true,
  "invite": {
    "id": "<string>",
    "assistant_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "email": "jsmith@example.com",
    "company_name": "<string>",
    "name": "<string>",
    "user_id": "<string>",
    "app_id": "<string>",
    "study_id": "<string>",
    "issilent": false,
    "istest": false,
    "isuniversal": false,
    "is_reward_sent": false,
    "reward_sent_at": "2023-11-07T05:31:56Z",
    "sent_at": "2023-11-07T05:31:56Z",
    "assistant_name": "<string>",
    "vapi_assistant_id": "<string>",
    "call_status": "2023-11-07T05:31:56Z",
    "enable_video_recording": true,
    "enable_chat": true,
    "screener_questions": [
      {
        "id": "<string>",
        "text": "<string>",
        "type": "single_select",
        "order": 123,
        "options": [
          {
            "id": "<string>",
            "text": "<string>",
            "disqualify": true
          }
        ]
      }
    ],
    "concept_image": "<unknown>",
    "study_type": "<string>",
    "is_concept_test": true,
    "language": "<string>",
    "chat_welcome_message": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.userintuition.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
call_id
string
required

The database ID of the call

Response

The requested call

​
id
string
required

Database primary key ID

​
call_id
string
required

The call ID from VAPI

​
assistant_id
string
required

The assistant ID

​
invite_id
string
required

Reference to the invite

​
user_id
string
required

User ID who owns this call

​
created_at
string<date-time>
required

Timestamp when the call record was created

​
updated_at
string<date-time>
required

Timestamp when the call record was last updated

​
app_id
string | null

App ID

​
transcript
string | null

Text transcript of the call

​
messages
object[] | null

JSON array of messages exchanged during the call

​
status
string | null

Current status of the call (e.g., started, ended, failed)

​
success_evaluation
string | null

Legacy evaluation label: Poor, Fair, Good, or Excellent

​
success_evaluation_details
object

Structured evaluation details containing score, label, and reasoning

​
ended_reason
string | null

Reason why the call ended (e.g., completed, timeout, error)

​
started_at
string<date-time> | null

Timestamp when the call started

​
ended_at
string<date-time> | null

Timestamp when the call ended

​
recording_url
string | null

URL to the call recording if available

​
video_recording_url
string | null

URL to the call video recording if available

​
analysis
object

JSON object containing interview analysis results

​
additional_info
object

JSON object containing additional information about the call

​
original_transcript
string | null

Original non-English transcript before translation to English

​
original_messages
object[] | null

Original non-English messages before translation to English

​
is_visible
boolean
default:true

Whether the call is visible to the user

​
invite
object

Associated invite information