Документы

Примечания
Экспертный уровень
Ключ API должен быть отправлен как токен носителя в заголовке авторизации запроса Получите ваш ключ API.
Список

Конечная точка API:

GET 
https://chat.ycla.ai/api/v1/documents

Пример запроса: 

curl --location --request GET 'https://chat.ycla.ai/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
необязательный string
Поисковый запрос
search_by
необязательный string
Искать по. Возможные значения: :значение для Название, :значение для Результат По умолчанию: name
template_id
необязательный integer
Фильтровать по идентификатору шаблона Возможные значения: :значение для Создай свой шаблон, :значение для О нас, :значение для Общая реклама, :значение для Статья в блог, :значение для Вводный абзац статьи, :значение для Структура блога, :значение для Заключительный абзац статьи, :значение для Абзацы для статьи, :значение для Посты для блога, :значение для Разделы блога, :значение для Тезисы статьи блога, :значение для Заголовок статьи, :значение для CTA блок, :значение для Рерайт контента, :значение для Краткое описание, :значение для Часто задаваемые вопросы, :значение для Хэштеги для поста, :значение для Заголовок - Title, :значение для Как это работает, :значение для Мета-описание Description, :значение для Мета ключевые слова, :значение для Заявление о миссии, :значение для Новостная рассылка, :значение для Проблема - Внимание - Решение, :значение для Создание параграфов, :значение для Пресс-релиз, :значение для Пост в социальную сеть, :значение для Описания к публикациям в социальных сетях, :значение для Идеи для стартапа, :значение для Названия стартапов, :значение для Подзаголовки - H1,H2,H3, :значение для Создание отзывов, :значение для Твитнуть, :значение для Тема в Twitter, :значение для Ценностные предложения, :значение для Описание видео, :значение для Сценарий Reels, :значение для Теги для видео, :значение для Название видео, :значение для Изложение концепции, :значение для Лист продукта, :значение для Приветственное письмо, :значение для Push-уведомления, :значение для План статьи, :значение для Грамматика контента, :значение для Теги для статьи блога, :значение для Плюсы и минусы, :значение для Реклама Google, :значение для Реклама в Facebook, :значение для Описание вакансий, :значение для Создание продающих обзоров на продукт и услуги, :значение для Разделы функций, :значение для Сценарий длинного ролика, :значение для Заголовки для Reels По умолчанию: freestyle
favorite
необязательный boolean
Фильтровать по избранным
sort_by
необязательный string
Сортировать по. Возможные значения: :значение для Дата создания, :значение для Название По умолчанию: id
sort
необязательный string
Сортировка. Возможные значения: :значение для По убыванию, :значение для По возрасту По умолчанию: desc
per_page
необязательный integer
Результаты на странице. Возможные значения: 10, 25, 50, 100 По умолчанию: 10
Показывать

Конечная точка API:

GET 
https://chat.ycla.ai/api/v1/documents/{id}

Пример запроса: 

curl --location --request GET 'https://chat.ycla.ai/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Магазин

Конечная точка API:

POST 
https://chat.ycla.ai/api/v1/documents

Пример запроса: 

curl --location --request POST 'https://chat.ycla.ai/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
Параметр
Тип
Описание
name
необходимый string
Название документа
prompt
необходимый string
Инструкция для искусственного интеллекта
creativity
необходимый float
The creative level of the result. Возможные значения: :значение для Повторяющийся, :значение для Детерминированный, :значение для Оригинал, :значение для Творческий, :значение для Образный По умолчанию: 0.5
Обновить

Конечная точка API:

PUT PATCH 
https://chat.ycla.ai/api/v1/documents/{id}

Пример запроса: 

curl --location --request PUT 'https://chat.ycla.ai/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
name
необязательный string
Название документа
result
необязательный string
Результат документа
favorite
необязательный boolean
Является ли документ избранным или нет
Удалить

Конечная точка API:

DELETE 
https://chat.ycla.ai/api/v1/documents/{id}

Пример запроса: 

curl --location --request DELETE 'https://chat.ycla.ai/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'