Osmi
Справочник API

Ассистенты

Настраивайте собственных ассистентов на базе выбранных моделей и сервисов

Создаёт нового ассистента с указанными параметрами.

HTTP
POST /assistants
Авторизация
string required
bearerAuth JWT-токен
Тело запроса (application/json)
{
  "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 — ошибка валидации

Получение ассистента по ID

HTTP
GET /assistants/{id} Возвращает данные конкретного ассистента по его ID
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id string - идентификатор ассистента

Коды ответов:

  • 200 — успешно, возвращается объект ассистента
  • 400 — некорректный ID
  • 404 — ассистент не найден
  • 422 — ошибка валидации
  • 500 — внутренняя ошибка сервера

Обновление ассистента

HTTP
PUT /assistants/{id} Обновляет данные существующего ассистента
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id string - идентификатор ассистента
Тело запроса (application/json)
{
  "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 — некорректный ID или отсутствует тело запроса
  • 404 — ассистент не найден
  • 500 — внутренняя ошибка

Удаление ассистента

HTTP
DELETE /assistants/{id} Удаляет ассистента по его ID
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id string - идентификатор ассистента

Коды ответов:

  • 200 — ассистент успешно удалён (без содержимого)
  • 400 — некорректный ID
  • 404 — ассистент не найден
  • 500 — внутренняя ошибка

Справочник API

Добро пожаловать в официальную документацию Osmi AI

Вложения