Изображения

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

API endpoint:

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

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

curl --location --request GET 'https://botwriter.org/api/v1/images' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
дополнительно string
Поисковый запрос.
search_by
дополнительно string
Поиск по. Возможные значения: name для Имя. По умолчанию: name.
resolution
дополнительно string
Фильтр по разрешению. Возможные значения: 256x256 для 256×256, 512x512 для Стандарт, 1024x1024 для 1024×1024, 1536x1536 для 1536x1536.
style
дополнительно string
Фильтр по стилю. Возможные значения: 3d-model для 3D model, analog-film для Analog Film, anime для Аниме, cinematic для Cinematic, comic-book для Comic Book, digital-art для Digital Art, enhance для Enhance, fantasy-art для Fantasy Art, isometric для Isometric, line-art для Line Art, low-poly для Low Poly, modeling-compound для Modeling Compound, neon-punk для Neon-punk, origami для Оригами, photographic для Photographic, pixel-art для Pixel Art, tile-texture для Tile Texture.
medium
дополнительно string
Фильтр по среднему значению. Возможные значения: acrylic для Акрил, canvas для Холст, chalk для Мел, charcoal для Древесный уголь, crayon для Карандаш, glass для Стекло, ink для Чернила, pastel для Пастель, pencil для Карандаш, spray_paint для Распыляемая краска, watercolor для Акварель.
filter
дополнительно string
Фильтр по фильтру. Возможные значения: grayscale для Черно-белый, sepia для Сепия, invert для Инверсия.
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/images/{id}

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

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

API endpoint:

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

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

curl --location --request POST 'https://botwriter.org/api/v1/images' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'description={description}'
Параметр
Тип
Описание
name
требуется string
Имя изображения.
description
требуется string
Описание изображения для ИИ.
resolution
требуется string
Разрешение изображения. Возможные значения: 256x256 для 256×256, 512x512 для Стандарт, 1024x1024 для 1024×1024, 1536x1536 для 1536x1536.
style
дополнительно string
Стиль изображения. Возможные значения: 3d-model для 3D model, analog-film для Analog Film, anime для Аниме, cinematic для Cinematic, comic-book для Comic Book, digital-art для Digital Art, enhance для Enhance, fantasy-art для Fantasy Art, isometric для Isometric, line-art для Line Art, low-poly для Low Poly, modeling-compound для Modeling Compound, neon-punk для Neon-punk, origami для Оригами, photographic для Photographic, pixel-art для Pixel Art, tile-texture для Tile Texture.
medium
дополнительно string
Носитель изображения. Возможные значения: acrylic для Акрил, canvas для Холст, chalk для Мел, charcoal для Древесный уголь, crayon для Карандаш, glass для Стекло, ink для Чернила, pastel для Пастель, pencil для Карандаш, spray_paint для Распыляемая краска, watercolor для Акварель.
filter
дополнительно string
Фильтр изображения. Возможные значения: grayscale для Черно-белый, sepia для Сепия, invert для Инверсия.
Обновление

API endpoint:

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

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

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

API endpoint:

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

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

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