Assistants

Create a new assistant

Create a new assistant with the provided details

post

/assistants

Authorizations

Body

idstring

Example: d290f1ee-6c54-4b01-90e6-d701748f0851

credentialstring

Example: 7db93c02-8d5a-4117-a8f1-3dfb6721b339

iconSrcstring

Example: /images/assistant.png

createdDatestring · date-time

Example: 2024-08-24T14:15:22Z

updatedDatestring · date-time

Example: 2024-08-24T14:15:22Z

detailsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/assistants' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"id":"d290f1ee-6c54-4b01-90e6-d701748f0851","credential":"7db93c02-8d5a-4117-a8f1-3dfb6721b339","iconSrc":"/images/assistant.png","createdDate":"2024-08-24T14:15:22Z","updatedDate":"2024-08-24T14:15:22Z","details":{"id":"asst_zbNeYIuXIUSKVHjJkfRo6ilv","name":"assistant","model":"gpt-4","instructions":"You are a helpful assistant, do your best to answer question and query","temperature":1,"top_p":1,"tools":["function","code_interpreter","file_search"],"tool_resources":{"ANY_ADDITIONAL_PROPERTY":{}}}}'

200

400

422

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
  "iconSrc": "/images/assistant.png",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z",
  "details": {
    "id": "asst_zbNeYIuXIUSKVHjJkfRo6ilv",
    "name": "assistant",
    "model": "gpt-4",
    "instructions": "You are a helpful assistant, do your best to answer question and query",
    "temperature": 1,
    "top_p": 1,
    "tools": [
      "function",
      "code_interpreter",
      "file_search"
    ],
    "tool_resources": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

Assistant created successfully

List all assistants

Retrieve a list of all assistants

get

/assistants

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/assistants' \
  --header 'Authorization: Bearer JWT'

200

500

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
  "iconSrc": "/images/assistant.png",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z",
  "details": {
    "id": "asst_zbNeYIuXIUSKVHjJkfRo6ilv",
    "name": "assistant",
    "description": "text",
    "model": "gpt-4",
    "instructions": "You are a helpful assistant, do your best to answer question and query",
    "temperature": 1,
    "top_p": 1,
    "tools": [
      "function",
      "code_interpreter",
      "file_search"
    ],
    "tool_resources": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

Successful operation

Get assistant by ID

Retrieve a specific assistant by ID

get

/assistants/{id}

Authorizations

Path parameters

idstringrequired

Assistant ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/assistants/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
  "iconSrc": "/images/assistant.png",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z",
  "details": {
    "id": "asst_zbNeYIuXIUSKVHjJkfRo6ilv",
    "name": "assistant",
    "description": "text",
    "model": "gpt-4",
    "instructions": "You are a helpful assistant, do your best to answer question and query",
    "temperature": 1,
    "top_p": 1,
    "tools": [
      "function",
      "code_interpreter",
      "file_search"
    ],
    "tool_resources": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

Successful operation

Update assistant details

Update the details of an existing assistant

put

/assistants/{id}

Authorizations

Path parameters

idstringrequired

Assistant ID

Body

idstring

Example: d290f1ee-6c54-4b01-90e6-d701748f0851

credentialstring

Example: 7db93c02-8d5a-4117-a8f1-3dfb6721b339

iconSrcstring

Example: /images/assistant.png

createdDatestring · date-time

Example: 2024-08-24T14:15:22Z

updatedDatestring · date-time

Example: 2024-08-24T14:15:22Z

detailsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/assistants/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"id":"d290f1ee-6c54-4b01-90e6-d701748f0851","credential":"7db93c02-8d5a-4117-a8f1-3dfb6721b339","iconSrc":"/images/assistant.png","createdDate":"2024-08-24T14:15:22Z","updatedDate":"2024-08-24T14:15:22Z","details":{"id":"asst_zbNeYIuXIUSKVHjJkfRo6ilv","name":"assistant","description":"text","model":"gpt-4","instructions":"You are a helpful assistant, do your best to answer question and query","temperature":1,"top_p":1,"tools":["function","code_interpreter","file_search"],"tool_resources":{"ANY_ADDITIONAL_PROPERTY":{}}}}'

200

400

404

500

200

No body

Assistant updated successfully

Delete an assistant

Delete an assistant by ID

delete

/assistants/{id}

Authorizations

Path parameters

idstringrequired

Assistant ID

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/assistants/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

No body

Assistant deleted successfully