Skip to main content
GET
Get an assistant

Authorizations

Authorization
string
header
required

Project API key (sk_api_…).

Path Parameters

realtimeAssistantId
string<uuid>
required

Query Parameters

version
default:draft

draft, prod, or a published version number. prod and a number return exactly what a call on them would run. A number that was never published is a 404.

Available options:
draft,
prod

Response

The assistant.

realtimeAssistantId
string<uuid>
organizationId
string<uuid>
projectId
string<uuid>
name
string
description
string
config
object

Keys beyond those listed are stored and returned unchanged.

public
boolean
createdAt
string<date-time>
updatedAt
string<date-time>
createdBy
string

Who created the assistant — an API key or a portal user.

updatedBy
string
version
integer

The version this response shows. Every save bumps it, so published numbers skip the saves in between.

Required range: x >= 1