Skip to main content

Create an assistant

POST 
/ai/assistants

Create a new AI Assistant.

Request​

Body

required

    name Name (string)required
    model Model (string)required
    description Description (string)
    instructions Instructions (string)required

    tools

    object[]

  • Array [

    • type Type (string)required

    Possible values: [retrieval, function]

    name Name (string)
    description Description (string)

    function

    object

    name Name (string)required
    description Description (string)

    parameters

    object

    type Type (string)required

    properties

    object

    required

    property name*

    ParameterProperties

    type Type (string)required
    description Description (string)
    enum string[]
    required string[]required

    retrieval

    object

    bucket_ids string[]required

  • ]

Responses​

200: Successful Response

Schema

    id Id (string)required
    name Name (string)required
    created_at date-timerequired
    description Description (string)
    model Model (string)required
    instructions Instructions (string)required

    tools

    object[]

  • Array [

    • tool_id Tool Id (string)required
    type Type (string)required

    Possible values: [retrieval, function]

    name Name (string)
    description Description (string)

    function

    object

    name Name (string)required
    description Description (string)

    parameters

    object

    type Type (string)required

    properties

    object

    required

    property name*

    ParameterProperties

    type Type (string)required
    description Description (string)
    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 Message (string)required
    type Error Type (string)required

  • ]

Loading...