Skip to main content

Get an assistant

GET 

/ai/assistants/:assistant_id

Retrieve an AI Assistant configuration by assistant_id.

Request

Path Parameters

    assistant_id Assistant Idrequired

Responses

200: Successful Response

Schema

    id Idrequired
    name Namerequired
    created_at date-timerequired
    description Description
    model Modelrequired
    instructions Instructionsrequired

    tools

    object[]

  • Array [

  • tool_id Tool Idrequired
    type Typerequired

    Possible values: [retrieval, function]

    name Name
    description Description

    function

    object

    name Namerequired
    description Description

    parameters

    object

    type Typerequired

    properties

    object

    required

    property name*

    ParameterProperties

    type Typerequired
    description Description
    enum string[]
    required string[]required

    retrieval

    object

    bucket_ids string[]required
  • ]

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...