Skip to main content

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.

​
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. You can authenticate with either an API key or a JWT token. 
Authorization: Bearer <your_api_key_or_jwt_token>
API keys are org-scoped, long-lived credentials ideal for server-to-server integrations and MCP clients. They start with the prefix ui_sk_. Create and manage your keys from the Manage Account pane in the dashboard — no API call required to get started.
1

Open Manage Account

Sign in to the User Intuition Dashboard, click your avatar in the bottom-left corner of the sidebar, then select Manage Account.
2

Go to the API Keys tab

In the account management dialog, click API Keys in the sidebar.
3

Create a key

Enter a descriptive name (for example, Production or MCP Server) and click Create Key. If you leave the name blank, it defaults to Default. The new key appears in a banner at the top of the page.
4

Copy the key immediately

Click Copy Key to copy it to your clipboard. The full key is only shown once — after you dismiss the banner or navigate away, only the key prefix remains visible.
5

Use the key

Pass the key as a Bearer token in the Authorization header:
Authorization: Bearer ui_sk_aBcDeFgHiJkLmNoPqRs...
To revoke a key, return to the API Keys tab and click the trash icon next to it. Revoked keys stop working immediately and cannot be restored.
The raw API key is only shown once at creation. If you lose it, revoke the old key and create a new one.
Prefer to provision keys programmatically? The same create, list, and revoke operations are available via the API Keys endpoints. See also Account settings → API keys for the full UI walkthrough.

​
JWT tokens

JWT tokens are short-lived tokens issued by the dashboard. They are useful for quick testing.
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.
Keep your JWT token secure and do not share it with others. This token provides authenticated access to your account.

​
Available Resources

API Keys

Generate and manage org-scoped API keys for programmatic access.

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 support@userintuition.ai.