POST
/
v1
/
assistants

Authorizations

X-Tune-Key
string
headerrequired

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.

modelName
string
description
string

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

instructions
string

Instructions for the assistant will be used as system prompt.

functionModel
object
responseModel
object
tools
object[]

Tools to be used for the assistant.

metadata
object

Metadata to store additional information in key-value pair.

userFilters
object

Response

200 - application/json
id
string

The id of the assistant.

description
string

The description of the assistant.

instructions
string

The instructions that the assistant uses.

tools
object[]

The tools that the assistant uses.

metadata
object

The metadata of the assistant.

createdAt
string

The time the assistant was created.

modelId
string

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

functionModel
object
responseModel
object
assistantName
string

The name of the assistant.

modelName
string

The name of the model.

userFilters
object

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