Assistants

Create a new assistant

post

Create a new assistant with the provided details

Authorizations

Body

idstringoptional

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

detailsobjectoptional

credentialstringoptional

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

iconSrcstringoptional

Example: /images/assistant.png

createdDatestring · date-timeoptional

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

updatedDatestring · date-timeoptional

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

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",
    "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": {}
      }
    },
    "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
    "iconSrc": "/images/assistant.png",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }'

200

400

422

200

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "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": {}
    }
  },
  "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
  "iconSrc": "/images/assistant.png",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Assistant created successfully

List all assistants

get

Retrieve a list of all 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",
  "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": {}
    }
  },
  "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
  "iconSrc": "/images/assistant.png",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Successful operation

Get assistant by ID

get

Retrieve a specific assistant by 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",
  "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": {}
    }
  },
  "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
  "iconSrc": "/images/assistant.png",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Successful operation

Update assistant details

put

Update the details of an existing assistant

Authorizations

Path parameters

idstringrequired

Assistant ID

Body

idstringoptional

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

detailsobjectoptional

credentialstringoptional

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

iconSrcstringoptional

Example: /images/assistant.png

createdDatestring · date-timeoptional

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

updatedDatestring · date-timeoptional

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

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",
    "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": {}
      }
    },
    "credential": "7db93c02-8d5a-4117-a8f1-3dfb6721b339",
    "iconSrc": "/images/assistant.png",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }'

200

400

404

500

200

No body

Assistant updated successfully

Delete an assistant

delete

Delete an assistant by 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