Пока это руководство есть только на английском. →
Параметры запроса
| Параметр | Обязательный | Описание |
|---|---|---|
image_url | Да | Картинка, с которой всё начинается. |
Цены
Цены указаны в кредитах, тех же, что вы используете на сайте (1 кредит = $0,01). Сумма резервируется, когда задача принята, и пересчитывается по фактической стоимости после завершения; за неудавшиеся задачи кредиты возвращаются.
| Вариант | Кредиты за изображение | ≈ USD |
|---|---|---|
| Стандарт | 0,72 | 0,0072 $ |
Каждая задача округляется вверх до целых кредитов, поэтому один запуск на самом дешёвом уровне стоит 1 кредит за изображение (0,01 $).
Чтобы узнать точную сумму до запуска, отправьте то же тело запроса на POST /jobs/quote.
Быстрый старт API
Вызов API Background Remover в три шага
- Создайте API-ключ. Войдите в PopNow и создайте ключ в консоли API. Ключи начинаются с sk-popnow- и списывают те же кредиты, что и сайт.
- Отправьте запрос. Отправьте POST /jobs/createTask с model popnow/background-remover-v1/edit и объектом input по таблице параметров. В ответе сразу придёт ID задачи.
- Получите результат. Опрашивайте GET /jobs/recordInfo по ID задачи или передайте callBackUrl — мы отправим результат туда. Когда задача выполнится, скачайте файлы по ссылкам.
# 1. Create the task. Keep the Idempotency-Key if you retry after a network error.
export IDEMPOTENCY_KEY="$(uuidgen)"
curl -X POST https://api.popnow.ai/api/v1/jobs/createTask \
-H "Authorization: Bearer $POPNOW_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $IDEMPOTENCY_KEY" \
-d '{
"model": "popnow/background-remover-v1/edit",
"input": {
"image_url": "https://media.popnow.ai/influencer/examples/marco.webp"
}
}'
# 2. Copy data.taskId from the response, then poll until state is succeeded, failed, canceled or expired.
TASK_ID="TASK_ID_FROM_RESPONSE"
curl "https://api.popnow.ai/api/v1/jobs/recordInfo?taskId=$TASK_ID" \
-H "Authorization: Bearer $POPNOW_API_KEY"Замените промпт и ссылки на свои. Справка по ответу, опросу статуса и callback есть на вкладке API.
Вопросы об API Background Remover
Сколько стоит API Background Remover?
Background Remover стоит 1 кредит (0,01 $) за изображение. Кредиты те же, что и на сайте (1 кредит = 0,01 $), новые аккаунты получают 30 бесплатных кредитов, а за неудачные задачи кредиты возвращаются.
Какое имя модели у Background Remover в API?
Укажите popnow/background-remover-v1/edit — Убрать фон в поле model запроса POST /jobs/createTask.
Нужно ли описывать объект?
Нет. Эндпоинт принимает одно поле, image_url, и сам выбирает передний план. Если на фото несколько кандидатов, сначала кадрируйте снимок до нужного.
Что приходит в ответ?
Один PNG с прозрачным фоном той же ширины и высоты, что и отправленное изображение, так что его можно сразу наложить на оригинал.
Можно ли подставить новый фон?
Не в том же вызове: инструмент только удаляет. Положите PNG на свой цвет или фото либо соберите новую сцену в Image Expander и наложите вырезку сверху.
Какие фотографии подходят лучше всего?
Снимки с одним четким объектом, который выделяется на фоне цветом или светом. Малоконтрастные края, смаз от движения и объекты, обрезанные краем кадра, — места, где вырезка сбоит.
Можно попробовать Background Remover без кода?
Да. Playground запускает Background Remover на ваших кредитах PopNow без API-ключа и показывает код для каждой генерации.