Skip to main content

​
External Integration API

The User Intuition API allows you to programmatically manage AI interview assistants, create invites, access call recordings and transcripts, and set up webhooks for automation.

OpenAPI Specification

View the complete OpenAPI specification

​
Base URL

All API requests should be made to: 
https://api.userintuition.ai

​
Authentication

All endpoints require Bearer token authentication. Include your JWT token in the Authorization header: 
Authorization: Bearer <your_jwt_token>

​
How to Get Your JWT Token

Follow these steps to retrieve your JWT authentication token:
1

Sign in to your account

Sign in to your User Intuition Dashboard if you haven’t already.
2

Open your profile

Click on your profile in the bottom-left corner of the sidebar. This will show your name and company.
3

Select View JWT Token

Select “View JWT Token” from the dropdown menu (it has a key icon).
4

Copy your token

A dialog will appear displaying your JWT token. Click the “Copy Token” button to copy the token to your clipboard.
5

Confirmation

You’ll see a confirmation message when the token has been successfully copied.
Security Warning: Keep your JWT token secure and do not share it with others. This token provides authenticated access to your account.

​
Available Resources

Assistants

List and manage your AI interview assistants with filtering and pagination.

Calls

Access call records, transcripts, recordings, and analysis data.

Invites

Create interview invitations and optionally send email notifications.

Webhooks

Set up automation webhooks to receive call data when interviews complete.

​
Response Format

All responses are returned in JSON format. Successful list responses include pagination information: 
{
  "items": [...],
  "total_count": 100,
  "page": 1,
  "page_size": 10
}

​
Error Handling

The API uses standard HTTP status codes:
Status CodeDescription
200Success
201Created
400Bad Request - Invalid input
401Unauthorized - Invalid or missing JWT token
404Not Found
500Internal Server Error
Error responses include a detail field with more information: 
{
  "detail": "Error message describing what went wrong"
}

​
Rate Limiting

API requests are rate limited to ensure fair usage. If you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

​
Support

For API support, contact [email protected].