POST
/
v1
/
assistants

Authorizations

X-Tune-Key
string
header
required

Tune API Keys are the preferred way to authenticate with the API. You can create an API Key from your Tune Studio Profile → 'Access Keys' (in sidebar)

Body

application/json
assistantName
string

Name of the assistant.

description
string

Description of the assistant with a maximum length of 512 characters.

functionModel
object
instructions
string

Instructions for the assistant will be used as system prompt.

metadata
object

Metadata to store additional information in key-value pair.

modelName
string
responseModel
object
tools
object[]

Tools to be used for the assistant.

userFilters
object

Response

200 - application/json
assistantName
string

The name of the assistant.

createdAt
string

The time the assistant was created.

description
string

The description of the assistant.

functionModel
object
id
string

The id of the assistant.

instructions
string

The instructions that the assistant uses.

metadata
object

The metadata of the assistant.

modelId
string

The model ID of the project-x-model that the assistant uses.

modelName
string

The name of the model.

responseModel
object
tools
object[]

The tools that the assistant uses.

userFilters
object

Allows users to have additional max 3 key-value pairs.