Pixoate API

Put supported Pixoate workflows inside your product

Background removal, AI upscaling, colorization, format conversion, object counting and OCR extraction — all through a single credit-metered REST API. Idempotent by design, with failed calls refunded automatically.

Get API accessFull API reference

Quick start

Send an image with a supported function name and get back a link to the processed result for that operation. API eligibility starts with the Pro plan.

curl -X POST https://api.pixoate.com/api/v1/process \
  -H "X-API-Key: $PIXOATE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "functionName=applyBackgroundRemoval" \
  -F "[email protected]"

Prefer to see it work first? Use the corresponding web product within its current allowance — for example, Background Remover runs applyBackgroundRemoval.

Endpoints

  • POST/api/v1/process

    Run a supported image operation such as background removal, upscale, enhance, resize, compression, colorization, or conversion.

  • POST/api/v1/count

    Count objects or people in an image and get the tally back.

  • POST/api/v1/extract

    OCR & structured extraction — pull text, tables and fields out of an image.

  • GET/api/v1/me

    Your account, plan and remaining credit balance.

Base URL https://api.pixoate.com. Processing endpoints require an API key, included from the Pro plan up.

What a call costs

The API is pay-as-you-go on credits. Two separate things: the Pro plan unlocks API access, and credits pay for the calls.

From 1 credit per call

Every processing call spends at least 1 credit; heavier AI operations can be priced higher. The response always reports the exact creditsSpent, and GET /api/v1/me returns your remaining balance.

Pro includes no credits

Pro buys the API key and self-serve rate limits — it does not come with a credit balance. You buy credits separately as a one-time pack, and they never expire. With a zero balance a call returns 402 rather than processing.

You only pay for results

A call that fails is refunded automatically. Every paid call requires an Idempotency-Key; retry the same input with the same key to replay its response instead of charging twice.

Pro plan pricing and the credit packs are both on the pricing page.

Commercial use

Every active paid plan and paid pass includes a commercial finished-work license: you may use, edit, print, publish and distribute finished work made with Pixoate in advertising, websites, social media, products and client projects, and may keep using that finished work after the paid period ends unless the purchase is refunded, reversed or charged back.

Included with every paid plan

Premium, Pro and Enterprise subscriptions include it while active. Active day and weekly passes include the same commercial-use rights during their term.

Do not resell assets alone

You may not sell, sublicense, share or distribute a Pixoate asset by itself or as stock, an asset pack, a standalone source asset or a reusable template.

What you can call

Image AI

Background removal, AI upscaling, photo enhancement, colorization and supported headshot generation.

Remove a background now

Object & people counting

Submit an image and receive object or people detections with a count for review.

Count objects now

OCR & data extraction

Extract supported receipt fields, handwriting text, business-card details or table CSV from an uploaded image.

Extract a receipt
The public API is currently synchronous and image-input based. Public PDF endpoints, asynchronous jobs, webhooks, API batch submission and official SDKs are not available yet; use the web application for those supported document and batch workflows.

Current reliability foundations

API-key auth

Eligible Pro, Team and Enterprise accounts receive a personal API key that can be rotated and sent in a request header.

Credit-metered, transparent

Every call spends from 1 credit and reports the amount spent. Failed calls are refunded automatically.

Idempotent retries

Every paid processing request requires an Idempotency-Key. A retry replays the original response for 24 hours instead of charging twice; a duplicate that arrives mid-flight or reuses the key for different input is rejected with 409.

Validate before you code

Use the corresponding web product within its published allowance to check output quality on your own images before integrating.

API access starts with the Pro plan

Eligible Pro, Team and Enterprise plans include a rotatable API key and commercial-use rights. Calls use credits purchased separately, and failed calls are refunded automatically. Subscriptions do not currently include a credit balance.

Get API accessContact Sales