История

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

API endpoint:

GET 
https://botwriter.org/api/v1/documents

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

curl --location --request GET 'https://botwriter.org/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
дополнительно string
Поисковый запрос.
search_by
дополнительно string
Поиск по. Возможные значения: name для Имя, result для Результат. По умолчанию: name.
template_id
дополнительно integer
Фильтр по идентификатору шаблона. Возможные значения: 1 для Любой запрос, 2 для О нас, 3 для Реклама, 4 для Статья, 5 для Описание блога, 6 для Конспект блога, 7 для Слоганы, 8 для Абзацы для блога, 9 для Посты для блога, 10 для Разделы для блога, 11 для Тезисы для блога, 12 для Заголовки для блога, 13 для Призыв к действию, 14 для Рерайт контента, 15 для Краткое содержание, 16 для FAQ, 17 для Хэштеги, 18 для Заголовок, 19 для Как это работает?, 20 для Мета-описание, 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 advertisement, 49 для Facebook advertisement, 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.
Показать

API endpoint:

GET 
https://botwriter.org/api/v1/documents/{id}

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

curl --location --request GET 'https://botwriter.org/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://botwriter.org/api/v1/documents

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

curl --location --request POST 'https://botwriter.org/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.
Обновление

API endpoint:

PUT PATCH 
https://botwriter.org/api/v1/documents/{id}

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

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

API endpoint:

DELETE 
https://botwriter.org/api/v1/documents/{id}

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

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