Перейти к основному содержимому
API docs by Redocly

Jay Copilot API (1.0.0)

Download OpenAPI specification:Download

API для работы с приложениями Jay Copilot.

Templates

Работа с шаблонами приложений.

Получение списка шаблонов приложений

Получение списка доступных пользователю шаблонов приложений.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "templates": {
    }
}

Apps

Работа с приложениями.

Создание приложения

Создание нового приложения

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
name
string

Имя приложения.

description
string

Описание приложения.

template
required
string

Идентификатор шаблона приложения.

params
object

Параметры приложения.

Responses

Request samples

Content type
application/json
{
  • "name": "Имя приложения",
  • "description": "Описание приложения",
  • "template": "Идентификатор шаблона приложения.",
  • "params": { }
}

Response samples

Content type
application/json
{
  • "id": "Идентификатор приложения",
  • "name": "Имя приложения",
  • "description": "Описание приложения",
  • "status": "READY",
  • "favorite": true,
  • "template": "Идентификатор шаблона приложения",
  • "params": { },
  • "meta": { },
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748
}

Получение списка приложений

Получение списка приложений.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "apps": [
    ]
}

Получение списка избранных приложений

Получение списка избранных приложений.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "apps": [
    ]
}

Получение приложения

Получение приложения по идентификатору.

Authorizations:
ApiKeyAuth
path Parameters
appId
required
string

Идентификатор приложения.

Responses

Response samples

Content type
application/json
{
  • "id": "Идентификатор приложения",
  • "name": "Имя приложения",
  • "description": "Описание приложения",
  • "status": "READY",
  • "favorite": true,
  • "template": "Идентификатор шаблона приложения",
  • "params": { },
  • "meta": { },
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748
}

Обновление приложения

Обновление приложения.

Authorizations:
ApiKeyAuth
path Parameters
appId
required
string

Идентификатор приложения.

Request Body schema: application/json
required
name
string

Имя приложения.

Responses

Request samples

Content type
application/json
{
  • "name": "Имя приложения"
}

Conversations

Работа с диалогами.

Создание диалога

Создание диалога с новым или существующим приложением.

Authorizations:
ApiKeyAuth
query Parameters
async
boolean
Default: false

Отправить асинхронный запрос.

Request Body schema: application/json
required
One of
name
string

Имя диалога.

required
object

Информация о приложении, с которым ведется диалог.

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Имя диалога",
  • "app": {
    }
}

Response samples

Content type
application/json
{
  • "id": "Идентификатор диалога",
  • "name": "Имя диалога",
  • "app": {
    },
  • "status": "READY",
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748,
  • "meta": { },
  • "history": [
    ]
}

Получение списка диалогов

Получение списка диалогов.

Authorizations:
ApiKeyAuth
query Parameters
hasUnreadChanges
boolean
Default: false

Фильтр по непрочитанным сообщениям.

Укажите true, чтобы получить только диалоги, где есть непрочитанные сообщения.

orderBy
string
Default: "updated"
Enum: "created" "updated"

Критерий сортировки диалогов.

Укажите created для сортировки по времени создания, updated — по времени последнего обновления.

sort
string
Default: "desc"
Enum: "asc" "desc"

Порядок сортировки диалогов по критерию orderBy.

Укажите asc для сортировки по возрастанию, desc — по убыванию.

limit
integer
Default: 1000

Максимальное количество полученных диалогов в списке.

skip
integer
Default: 0

Количество диалогов из начала списка, формирующегося на основе параметров сортировки, которые будут пропущены.

Responses

Response samples

Content type
application/json
{
  • "conversations": [
    ]
}

Получение диалога

Получение диалога по идентификатору.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

Responses

Response samples

Content type
application/json
{
  • "id": "Идентификатор диалога",
  • "name": "Имя диалога",
  • "app": {
    },
  • "status": "READY",
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748,
  • "meta": { },
  • "history": [
    ]
}

Удаление диалога

Удаление диалога по идентификатору.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

Responses

Обновление диалога

Обновление диалога.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

Request Body schema: application/json
required
name
string

Новое имя диалога.

Responses

Request samples

Content type
application/json
{
  • "name": "Новое имя диалога"
}

Response samples

Content type
application/json
{
  • "id": "Идентификатор диалога",
  • "name": "Имя диалога",
  • "app": {
    },
  • "status": "READY",
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748,
  • "meta": { },
  • "history": [
    ]
}

Обновление приложения, с которым ведется диалог

Обновление приложения, с которым ведется диалог.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

Request Body schema: application/json
required
name
string

Имя приложения.

description
string

Описание приложения.

template
required
string

Идентификатор шаблона приложения.

params
object

Параметры приложения.

Responses

Request samples

Content type
application/json
{
  • "name": "Имя приложения",
  • "description": "Описание приложения",
  • "template": "Идентификатор шаблона приложения.",
  • "params": { }
}

Response samples

Content type
application/json
{
  • "id": "Идентификатор диалога",
  • "name": "Имя диалога",
  • "app": {
    },
  • "status": "READY",
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748,
  • "meta": { },
  • "history": [
    ]
}

Удаление истории сообщений

Удаление истории сообщений диалога и сброс контекста.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

Responses

Response samples

Content type
application/json
{
  • "id": "Идентификатор диалога",
  • "name": "Имя диалога",
  • "app": {
    },
  • "status": "READY",
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748,
  • "meta": { },
  • "history": [
    ]
}

Сброс контекста

Сброс контекста диалога (без удаления истории).

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

Responses

Response samples

Content type
application/json
{
  • "id": "Идентификатор диалога",
  • "name": "Имя диалога",
  • "app": {
    },
  • "status": "READY",
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748,
  • "meta": { },
  • "history": [
    ]
}

Messages

Работа с сообщениями и историей диалогов.

Отправка сообщения

Отправка сообщения в диалог.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

query Parameters
async
boolean
Default: false

Отправить асинхронный запрос.

Request Body schema: multipart/form-data
required
file
string <binary>
text
string

Responses

Response samples

Content type
application/json
{
  • "id": "Идентификатор сообщения",
  • "conversationId": "Идентификатор диалога",
  • "status": "success",
  • "type": "request",
  • "content": [
    ],
  • "meta": { },
  • "createdAt": 1700661509748,
  • "updatedAt": 1700661509748
}

Получение истории сообщений

Получение истории сообщений диалога.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

query Parameters
pageSize
integer
Default: 20

Количество сообщений в ответе.

before
string <uuid>
Example: before=c491da05-277b-494f-a4dd-25b33d25b213

Идентификатор последнего сообщения.

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

Отмена сообщения

Отмена обработки последнего сообщения в диалоге.

Authorizations:
ApiKeyAuth
path Parameters
conversationId
required
string

Идентификатор диалога.

Responses

Files

Работа с файлами.

Загрузка файла

Загрузка файла на сервер.

Authorizations:
ApiKeyAuth
Request Body schema: multipart/form-data
required
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "Идентификатор файла",
  • "name": "Имя файла",
  • "url": "https://example.com/file.pdf",
  • "contentType": "application/pdf",
  • "contentSize": 1024,
  • "createdAt": 1700661509748,
  • "meta": { }
}

Удаление файлов

Множественное удаление файлов с сервера.

Authorizations:
ApiKeyAuth
query Parameters
fileIds
required
string
Example: fileIds=id1,id2

Список идентификаторов файлов, разделенных запятой.

Responses

Response samples

Content type
application/json
{
  • "files": {
    }
}

Загрузка файлов

Множественная загрузка файлов на сервер.

Authorizations:
ApiKeyAuth
Request Body schema: multipart/form-data
required
files
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получение файла

Получение с сервера информации о файле.

Authorizations:
ApiKeyAuth
path Parameters
fileId
required
string

Идентификатор файла.

Responses

Response samples

Content type
application/json
{
  • "id": "Идентификатор файла",
  • "name": "Имя файла",
  • "url": "https://example.com/file.pdf",
  • "contentType": "application/pdf",
  • "contentSize": 1024,
  • "createdAt": 1700661509748,
  • "meta": { }
}

Удаление файла

Удаление файла с сервера.

Authorizations:
ApiKeyAuth
path Parameters
fileId
required
string

Идентификатор файла.

Responses

Скачивание файла

Скачивание файла с сервера.

Пользователь может скачивать только свои файлы. Роли COPILOT_ADMIN и COPILOT_ACCOUNT_AUDITOR позволяют скачивать файлы других пользователей в рамках аккаунта — для этого нужно передать ID владельца файла в заголовке запроса.

Authorizations:
ApiKeyAuth
path Parameters
fileId
required
string

Идентификатор файла.

header Parameters
X-File-Original-User-Id
string

Идентификатор пользователя, чей файл вы хотите скачать. Если не передать этот заголовок, метод будет искать файл только среди файлов владельца API-ключа.

Responses

Поиск файлов

Поиск файлов по заданным фильтрам: дате загрузки, формату, конкретному диалогу или владельцу.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
required
object

Условия поиска файлов.

required
object

Настройки сортировки результатов.

object

Параметры пагинации.

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "sort": {
    },
  • "page": {
    }
}

Response samples

Content type
application/json
{
  • "totals": {
    },
  • "files": [
    ]
}