assistants

Get Assistant By Slug

Get a single assistant by URL slug.

get/api/assistants/by-slug/{url_slug}

Path parameters

url_slugstring required

Response

Successful Response

model'gpt-4o'

instructionsstring nullable

knowledge_base_idstring uuid nullable required

context_limitinteger nullable

The maximum number of context chunks to include in a run.

codex_access_keystring nullable

codex_as_cacheboolean

namestring required

The name of the assistant

descriptionstring required

The description of the assistant

url_slugstring nullable

Optional URL suffix - unique identifier for the assistant's endpoint

suggested_questionsstring[]

A list of suggested questions that can be asked to the assistant

logo_s3_keystring nullable

S3 object key to the assistant's logo image

logo_textstring nullable

Text to display alongside the assistant's logo

idstring uuid required

created_atstring date-time required

updated_atstring date-time required

deleted_atstring date-time nullable required

Changes

Changed in 10 of the 26 revisions of this API.2312

Aug 5, 20259e6009a931b622See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 15, 2025f22c2d6c16f01See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 14, 2025b890eea391441See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Apr 10, 2025d95b89c34a942See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 22, 20252aa38a4bc52c13See the full diff
- ●
  removed the optional property //// from the response with the status
  response-optional-property-removed
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed from the // response property anyOf list for the response status
  response-property-any-of-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 2, 202560c8c820f2cb1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Dec 13, 2024a5e85dccbbe31See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Dec 5, 2024df1d1cc9e0501See the full diff
- ▲
  the response property const value gpt-4o was removed for the status
  response-property-const-removed
Dec 3, 2024c3d745f0888a1See the full diff
- ▲
  response property knowledge_base_id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 1, 202436e7c2cdfead1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history