Документы

Примечания
Для опытных пользователей
Передавайте API-ключ как Bearer-токен в заголовке Authorization. Создать API-ключ.
Список

URL API:

GET 
https://nexchat.store/api/v1/documents

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

curl --location --request GET 'https://nexchat.store/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
дополнительно string
Например: название документа, шаблона или ключевая фраза.
search_by
дополнительно string
Поиск по. Возможные значения: name для Имя, result для Результат. По умолчанию: name.
template_id
дополнительно integer
Отфильтруйте по ID шаблона. Возможные значения: 1 для Свободный формат, 2 для О нас, 3 для Рекламный текст, 4 для Статья, 5 для Вступление, 6 для План блога, 7 для Финал статьи, 8 для Абзац блога, 9 для Пост в блог, 10 для Раздел блога, 11 для Тезисы для блога, 12 для Заголовок блога, 13 для CTA, 14 для Переписать текст, 15 для Краткая выжимка, 16 для Вопросы и ответы, 17 для Хэштеги, 18 для Заголовок, 19 для Как это работает, 20 для SEO-описание, 21 для Мета-ключевые слова, 22 для Миссия, 23 для Рассылка, 24 для Боль - Усиление - Решение, 25 для Абзац, 26 для Пресс-релиз, 27 для Посты для соцсетей, 28 для Подпись к посту, 29 для Идеи для стартапов, 30 для Названия стартапов, 31 для Подзаголовок, 32 для Отзыв, 33 для Social media quote, 34 для Биография в социальных сетях, 35 для Ценность продукта, 36 для Текст для видео, 37 для Видеосценарий, 38 для Видеотеги, 39 для Название видео, 40 для Видение, 41 для Карточка товара, 42 для Приветственное письмо, 43 для Push-уведомление, 44 для Идеи для блога, 45 для Проверка на ошибки, 46 для Теги для блога, 47 для Плюсы и минусы, 48 для Реклама в Google, 49 для Реклама в Facebook, 50 для Описание работы, 51 для Отзывы, 52 для Блок преимуществ. По умолчанию: freestyle.
favorite
дополнительно boolean
Фильтр по избранному.
sort_by
дополнительно string
Сортировать по. Возможные значения: id для Дата создания, name для Имя. По умолчанию: id.
sort
дополнительно string
Сортировать. Возможные значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.
per_page
дополнительно integer
Элементов на странице. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Открыть

URL API:

GET 
https://nexchat.store/api/v1/documents/{id}

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

curl --location --request GET 'https://nexchat.store/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Создать

URL API:

POST 
https://nexchat.store/api/v1/documents

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

curl --location --request POST 'https://nexchat.store/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 для Повторяющиеся, 0.25 для Детерминированный, 0.5 для Оригинал, 0.75 для Креативный, 1 для Творческий. По умолчанию: 0.5.
Сохранить

URL API:

PUT PATCH 
https://nexchat.store/api/v1/documents/{id}

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

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

URL API:

DELETE 
https://nexchat.store/api/v1/documents/{id}

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

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