Jay Copilot API (1.0.0)
Download OpenAPI specification:Download
API для работы с приложениями Jay Copilot.
Загрузка файла
Загрузка файла на сервер.
Authorizations:
Request Body schema: multipart/form-datarequired
file | string <binary> |
Responses
Response samples
- 200
{- "id": "Идентификатор файла",
- "name": "Имя файла",
- "contentType": "application/pdf",
- "contentSize": 1024,
- "createdAt": 1700661509748,
- "meta": { }
}
Получение файла
Получение файла с сервера.
Authorizations:
path Parameters
fileId required | string Идентификатор файла. |
Responses
Response samples
- 200
{- "id": "Идентификатор файла",
- "name": "Имя файла",
- "contentType": "application/pdf",
- "contentSize": 1024,
- "createdAt": 1700661509748,
- "meta": { }
}
Получение списка шаблонов приложений
Получение списка доступных пользователю шаблонов приложений.
Authorizations:
Responses
Response samples
- 200
{- "templates": {
- "property1": {
- "categories": [
- "content",
- "data"
], - "label": "Название шаблона приложения",
- "info": {
- "icon": "📧",
- "title": "Деловое письмо",
- "description": "Составит деловое письмо или ответ на него на указанную тему",
- "prompt": "Текст промта"
}, - "params": { },
- "autoCreate": false,
- "requiredFeature": "copilot_access",
- "startRequest": "Текст стартового запроса."
}, - "property2": {
- "categories": [
- "content",
- "data"
], - "label": "Название шаблона приложения",
- "info": {
- "icon": "📧",
- "title": "Деловое письмо",
- "description": "Составит деловое письмо или ответ на него на указанную тему",
- "prompt": "Текст промта"
}, - "params": { },
- "autoCreate": false,
- "requiredFeature": "copilot_access",
- "startRequest": "Текст стартового запроса."
}
}
}
Создание приложения
Создание нового приложения
Authorizations:
Request Body schema: application/jsonrequired
name | string Имя приложения. |
description | string Описание приложения. |
template required | string Идентификатор шаблона приложения. |
params | object Параметры приложения. |
Responses
Request samples
- Payload
{- "name": "Имя приложения",
- "description": "Описание приложения",
- "template": "Идентификатор шаблона приложения.",
- "params": { }
}
Response samples
- 200
{- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
Response samples
- 200
{- "apps": [
- {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Получение списка избранных приложений
Получение списка избранных приложений.
Authorizations:
Responses
Response samples
- 200
{- "apps": [
- {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Получение приложения
Получение приложения по идентификатору.
Authorizations:
path Parameters
appId required | string Идентификатор приложения. |
Responses
Response samples
- 200
{- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
Создание диалога
Создание диалога с новым или существующим приложением.
Authorizations:
query Parameters
async | boolean Default: false Отправить асинхронный запрос. |
Request Body schema: application/jsonrequired
name | string Имя диалога. |
required | object Информация о приложении, с которым ведется диалог. |
Responses
Request samples
- Payload
{- "name": "Имя диалога",
- "app": {
- "id": "Идентификатор приложения"
}
}
Response samples
- 200
{- "id": "Идентификатор диалога",
- "name": "Имя диалога",
- "app": {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}, - "status": "READY",
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748,
- "meta": { },
- "history": [
- {
- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Получение списка диалогов
Получение списка диалогов.
Authorizations:
query Parameters
hasUnreadChanges | boolean Default: false Фильтр по непрочитанным сообщениям. Укажите |
orderBy | string Default: "updated" Enum: "created" "updated" Критерий сортировки диалогов. Укажите |
sort | string Default: "desc" Enum: "asc" "desc" Порядок сортировки диалогов по критерию Укажите |
Responses
Response samples
- 200
{- "conversations": [
- {
- "id": "Идентификатор диалога",
- "name": "Имя диалога",
- "app": {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}, - "status": "READY",
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748,
- "meta": { },
- "history": [
- {
- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
]
}
Получение диалога
Получение диалога по идентификатору.
Authorizations:
path Parameters
conversationId required | string Идентификатор диалога. |
Responses
Response samples
- 200
{- "id": "Идентификатор диалога",
- "name": "Имя диалога",
- "app": {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}, - "status": "READY",
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748,
- "meta": { },
- "history": [
- {
- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Обновление диалога
Обновление диалога.
Authorizations:
path Parameters
conversationId required | string Идентификатор диалога. |
Request Body schema: application/jsonrequired
name | string Новое имя диалога. |
Responses
Request samples
- Payload
{- "name": "Новое имя диалога"
}
Response samples
- 200
{- "id": "Идентификатор диалога",
- "name": "Имя диалога",
- "app": {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}, - "status": "READY",
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748,
- "meta": { },
- "history": [
- {
- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Обновление приложения, с которым ведется диалог
Обновление приложения, с которым ведется диалог.
Authorizations:
path Parameters
conversationId required | string Идентификатор диалога. |
Request Body schema: application/jsonrequired
name | string Имя приложения. |
description | string Описание приложения. |
template required | string Идентификатор шаблона приложения. |
params | object Параметры приложения. |
Responses
Request samples
- Payload
{- "name": "Имя приложения",
- "description": "Описание приложения",
- "template": "Идентификатор шаблона приложения.",
- "params": { }
}
Response samples
- 200
{- "id": "Идентификатор диалога",
- "name": "Имя диалога",
- "app": {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}, - "status": "READY",
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748,
- "meta": { },
- "history": [
- {
- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Удаление истории сообщений
Удаление истории сообщений диалога (очистка контекста).
Authorizations:
path Parameters
conversationId required | string Идентификатор диалога. |
Responses
Response samples
- 200
{- "id": "Идентификатор диалога",
- "name": "Имя диалога",
- "app": {
- "id": "Идентификатор приложения",
- "name": "Имя приложения",
- "description": "Описание приложения",
- "status": "READY",
- "favorite": true,
- "template": "Идентификатор шаблона приложения",
- "params": { },
- "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}, - "status": "READY",
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748,
- "meta": { },
- "history": [
- {
- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Получение истории сообщений
Получение истории сообщений диалога.
Authorizations:
path Parameters
conversationId required | string Идентификатор диалога. |
query Parameters
pageSize | integer Default: 20 Количество сообщений в ответе. |
before | string <uuid> Example: before=c491da05-277b-494f-a4dd-25b33d25b213 Идентификатор последнего сообщения. |
Responses
Response samples
- 200
{- "messages": [
- {
- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}
]
}
Отправка сообщения
Отправка сообщения в диалог.
Authorizations:
path Parameters
conversationId required | string Идентификатор диалога. |
query Parameters
async | boolean Default: false Отправить асинхронный запрос. |
Request Body schema: multipart/form-datarequired
file | string <binary> |
text | string |
Responses
Response samples
- 200
{- "id": "Идентификатор сообщения",
- "conversationId": "Идентификатор диалога",
- "status": "success",
- "type": "request",
- "content": [
- {
- "type": "text",
- "text": "Текст сообщения",
- "localizationKey": "ru"
}
], - "meta": { },
- "createdAt": 1700661509748,
- "updatedAt": 1700661509748
}