Что такое API?

Carve.API — это наш внешний интерфейс для автоматического удаления фона с изображений и видео, который вы можете очень просто интегрировать в ваше приложение или бизнес-процесс.

Простая интеграция

Наш API — простой HTTP-интерфейс с гибкими настройками:

• Фото: JPEG, PNG, WebP, AVIF (до 25 мегапикселей)
• Видео: MP4, MOV, WebM, MKV, AVI, WMV и другие (H.264, HEVC, VP9, AV1, ProRes и ещё 14 кодеков)
• Результат: файл изображения или видео (видео — до 1920x1080)

Лучше всего работает с изображениями с передним планом (например, люди, товары, животные, автомобили и т.д.).

Начало работы

1. Получите API-ключ в личном кабинете.
2. Используйте примеры кода ниже для быстрого старта.

При регистрации вы получаете бесплатные баллы для тестирования API (см. тарифы).

Быстрый старт

# Отправить изображение
curl -X POST \
  -H "X-API-Key: ВАШ_API_КЛЮЧ" \
  -F "image=@фото.jpg" \
  https://api.carve.photos/api/v1/images/remove_bg

# Ответ: {"image_id": "a1b2c3d4-..."}

# Получить результат
curl -H "X-API-Key: ВАШ_API_КЛЮЧ" \
  https://api.carve.photos/api/v1/images/images/a1b2c3d4-...

# Ответ: {"image_url": "https://..."}

# 1. Создать задачу
curl -X POST \
  -H "X-API-Key: ВАШ_API_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{"processing_type":"human","format":"mp4","background_color":"#00B140"}' \
  https://api.carve.photos/api/v1/videos/remove_bg

# Ответ: {"video_id":"abc-123","upload_data":{"url":"...","fields":{...}}}

# 2. Загрузить файл (url и fields из ответа шага 1)
# Данные параметры могут отличаться, необходимо использовать те, что вернулись в ответе.
curl -X POST {upload_url} \
  -F "key={key}" -F "policy={policy}" \ 
  -F "x-amz-signature={sig}" -F "acl=private" \
  -F "file=@видео.mp4"

# 3. Подтвердить загрузку
curl -X PUT \
  -H "X-API-Key: ВАШ_API_КЛЮЧ" \
  https://api.carve.photos/api/v1/videos/abc-123/source

# 4. Получить результат
curl -H "X-API-Key: ВАШ_API_КЛЮЧ" \
  https://api.carve.photos/api/v1/videos/abc-123

# Ответ: {"video_id":"abc-123","status":"completed","result_url":"https://..."}

Подробные примеры на Python, JavaScript, PHP — в разделах Изображения и Видео.

Тарификация

При ошибке обработки баллы возвращаются автоматически.
Подробнее о ценах — на странице тарифов.

Аутентификация

При каждом запросе передавайте ключ в заголовке:

X-API-Key: ВАШ_API_КЛЮЧ

Получить ключ можно в личном кабинете после регистрации.

Rate Limit

На данный момент количество запросов не ограничено.
При введении лимитов существующие интеграции продолжат работать. О лимитах мы предупредим заранее в наших соц. сетях: Telegram-канале и группе ВКонтакте.

Интерактивная документация

• Swagger — интерактивные запросы прямо из браузера
• Redoc — подробное описание всех схем и параметров