Assistants

PreviousAPI Reference NextAttachments

Last updated 16 days ago

Delete an assistant

delete

Delete an assistant by ID

Authorizations

Path parameters

idstringRequired

Assistant ID

Responses

200

Assistant deleted successfully

400

The specified ID is invalid

404

Assistant not found

500

Internal error

delete

DELETE /assistants/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

Get assistant by ID

get

Retrieve a specific assistant by ID

Authorizations

Path parameters

idstringRequired

Assistant ID

Responses

200

Successful operation

application/json

400

The specified ID is invalid

404

Assistant not found

500

Internal error

get

GET /assistants/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "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"
}

Create a new assistant

post

Create a new assistant with the provided details

Authorizations

Body

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

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

iconSrcstringOptionalExample: /images/assistant.png

createdDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z

updatedDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z

Responses

200

Assistant created successfully

application/json

400

Invalid input provided

422

Validation exception

post

POST /assistants HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 526

{
  "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"
}

{
  "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"
}

Update assistant details

put

Update the details of an existing assistant

Authorizations

Path parameters

idstringRequired

Assistant ID

Body

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

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

iconSrcstringOptionalExample: /images/assistant.png

createdDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z

updatedDatestring · date-timeOptionalExample: 2024-08-24T14:15:22Z

Responses

200

Assistant updated successfully

application/json

400

The specified ID is invalid or body is missing

404

Assistant not found

500

Internal error

put

PUT /assistants/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 526

{
  "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"
}

{
  "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"
}