🚢
API Docs
  • С чего начать?
  • Стоимость запросов
  • Интеграция чат-ботов
  • Токенизация
  • API - Ассистенты
    • Assistant API
    • Чат с ассистентом
  • API - Общие запросы
    • Запрос баланса
  • API - OpenAI -ChatGPT
    • Список моделей
    • Запрос чату
  • API - OpenAI - Embedding
    • embedding-ada-v2
    • text-embedding-3-small
    • text-embedding-3-large
  • Moderation
    • text-moderation
  • RAG DATABASE
    • List of RAGs
    • List of files
    • Add file to RAG
    • Delete file from RAG
  • FaceSwap 2.0
    • /create
    • /result
  • Background Remover
    • /create
    • /result
  • API -Midjourney
    • /imagine
    • /result
    • /upsample
    • /variation
    • /outpaint
    • /pan
    • /upscale
    • /inpaint
    • /reroll
Powered by GitBook
On this page
  • Создать задачу на удаление фона
  • Пример запроса
  • Пример ответа
  1. Background Remover

/create

Для удаления фона с фотографии вам нужно отправить изображение в наш API. Вы можете отправить его в виде ссылки или в image/base64 и они должны быть обязательно в форматах PNG или JPEG.

Previous/resultNext/result

Last updated 10 months ago

Чтобы отправлять авторизованные запросы нужно получить API ключ, как это сделать написано в разделе

Рассмотрим пример, где мы хотим удалить фон на фотографии:

Создать задачу на удаление фона

POST https://gptunnel.ru/v1/bgremover/create

Удаление фона с использованием нашего ИИ может занимать от 1 до 30 секунд в зависимости от загрузки сервера, поэтому мы создаем асинхронные задачи и получаем результат по мере готовности через webhook либо дополнительный запрос.

Headers

Name
Type
Description

Authorization*

string

API ключ

Request Body

Name
Type
Description

sourceImage*

string

png or jpeg

useWalletBalance

bool

Использовать личный счет

webhook

string

URL для отправки результата

{
	"id": "65819c485337280001a609e7",
	"parentId": null,
	"object": "task",
	"type": "@BGRemover",
	"percent": 0,
	"status": "idle",
	"error": null,
	"usage": {
		"prompt_tokens": 0,
		"completion_tokens": 1,
		"total_tokens": 1,
		"prompt_cost": 0,
		"completion_cost": 10,
		"total_cost": 10
	}
}
{
  "error": {
    "message": "'sourceImage' is a required property",
    "type": "invalid_request_error",
    "param": null,
    "code": null
  }
}
{
  "error": {
    "message": "Organization balance is too low to use API",
    "type": "insufficient_balance_error",
    "param": null,
    "code": null
  }
}
{
  "error": {
    "message": "Unauthorized",
    "type": "unauthorized_request_error",
    "param": null,
    "code": null,
  }
}

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

import axios from 'axios'

const request = axios({
  method: 'POST',
  url: 'https://gptunnel.ru/v1/bgremover/create',
  headers: {
    // use your API key here
    Authorization: 'YOUR_API_KEY',
  },
  data: {
    sourceImage: "https://storage.yandexcloud.net/timenote/photo_bgremover_original.webp",
    webhook: null,
    useWalletBalance: false
  }
})

request.then((result) => {
  console.log(result)
}).catch((error) => {
  console.error(error)
})
curl --request POST \
  --url https://gptunnel.ru/v1/faceswap/create \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "sourceImage": "https://storage.yandexcloud.net/timenote/fs_source.jpg",
    "faceImage": "https://storage.yandexcloud.net/timenote/fs_face.jpg",
    "webhook": null,
    "useWalletBalance": false
}'

Пример ответа

{
	"id": "65819c485337280001a609e7",
	"parentId": null,
	"object": "task",
	"type": "@BGRemover",
	"percent": 0,
	"status": "idle",
	"error": null,
	"usage": {
		"prompt_tokens": 0,
		"completion_tokens": 1,
		"total_tokens": 1,
		"prompt_cost": 0,
		"completion_cost": 10,
		"total_cost": 10
	}
}

Результат будет получен через webhook, который был указан в запросе, или через метод /result. Информацию о методе /result можно найти на следующей странице.

С чего начать?
Как удалить фон на фотографии через API