Support Try camelAI
iframe / Create iframe link

iframe

Create iframe link

Creates a secure iframe link with a cached JWT token.

POST /api/v1/iframe/create

Headers

Authorizationrequired

any - API key authentication using Bearer scheme

Request Body

uidrequired

string - User identifier: The UID of the user to create the iframe for. This is used to track usage and thread history. This can be anything you want, but it must be unique. We recommend using a user ID or email.

srcsrequired

array - List of Source/Connection IDs: The IDs of the sources/connections to use for the iframe. This is used to determine which sources/connections the user will have access to in the chat.

ttl

integer - Token lifetime in seconds (60-3600, default: 900)

knowledge_base_entries

array - Array of session-specific (stateless) knowledge base entries. These temporary entries apply only to this iframe instance and do not persist. They work alongside any persistent (stateful) entries previously created through /api/v1/knowledge-base/ for your connection IDs.

reference_queries

array - Array of session-specific (stateless) reference query objects (e.g., {"title": "...", "query": "..."}). These temporary queries apply only to this iframe instance and do not persist. They work alongside any persistent (stateful) queries previously created through /api/v1/reference-queries/ for your connection IDs.

model

enum<string>: o3, o4-mini, gpt-4.1, gpt-5, gpt-5-codex, sonnet-4, sonnet-4.5, haiku-4.5 - Model to use for generated threads * `o3` - o3 * `o4-mini` - o4-mini * `gpt-4.1` - gpt-4.1 * `gpt-5` - gpt-5 * `gpt-5-codex` - gpt-5-codex * `sonnet-4` - sonnet-4 * `sonnet-4.5` - sonnet-4.5 * `haiku-4.5` - haiku-4.5

response_mode

enum<string>: full, basic - Deprecated fallback. Prefer configuring response mode on the theme; this request parameter is only used if the theme is missing a response_mode. * `full` - full * `basic` - basic

theme

object - Theme configuration to apply to the iframe (theme_mode, custom_css_vars, start_message)

theme_id

integer - ID of the theme to apply (mutually exclusive with theme)

show_sidebar

boolean - Deprecated fallback. Prefer configuring sidebar visibility on the theme; this request parameter is only used if the theme is missing a show_sidebar value.

show_dashboards

boolean - Deprecated fallback. Prefer configuring dashboard visibility on the theme; this request parameter is only used if the theme is missing a show_dashboards value.

limits

object - Optional per-uid rate limits

Response

iframe_urlrequired

string - URL for the iframe view

cache_keyrequired

string - Cache key for JWT retrieval

expires_inrequired

integer - Token lifetime in seconds