--- title: "REST API" description: "Register images with the XI Parallax engine so they can be found again, and look images up to learn whether they are already registered." published: 2026-09-22T14:01:25.9707+00:00 updated: 2026-09-22T14:01:25.9707+00:00 url: https://xiobjects.com/docs/xio/parallax/rest-api source: XI Objects --- # REST API XI Parallax exists to recover lost attribution. During the closed beta, look-up and the records request require an API token issued by XI Objects. At general release, both become generally available without a token, so anyone can find a registered image and recover its attribution. Registration and take-down remain operations for token holders. A creator registers an image together with the manifests that say who made it and on what terms: their own JSON, a C2PA manifest, whatever they attach. Parallax derives what the engine needs, discards the pixels, and publishes a signed record. Later, anyone who finds that image, or a copy, a crop or a derivative of it, can look it up, get the original image's hash from the match, and ask for that record. The manifests come back. It does not matter which account registered the image, and it does not matter that the file they found had the metadata stripped out of it years ago. Finding the image and recovering its attribution are two requests. [Look-up](/docs/xio/parallax/rest-api/look-up-single-image) finds the original. [The records request](/docs/xio/parallax/rest-api/records) recovers the attribution. The API is a private beta. An operator mints an API token for your account and gives it to you. Every route except the health check requires that token. Base URL: `https://api.parallax.xiobjects.com` ## How to read this collection Start with [Getting Started](/docs/xio/parallax/rest-api/getting-started). It covers the token, the health check, the error shape, and a full first pass: register an image, look it up, take it down. After that, pick the page for the job you are doing. The guides explain the order of calls and what each answer means. The [REST API reference](/docs/xio/parallax/rest-api/reference) lists every endpoint with its request fields, response shapes and statuses. ## Pages - [Getting Started](/docs/xio/parallax/rest-api/getting-started): the token, the health check, the OpenAPI document, the error shape, and a first end to end pass. - [Register a single image](/docs/xio/parallax/rest-api/register-single-image): one image in one request, and what each refusal means. - [Register in batches](/docs/xio/parallax/rest-api/register-in-batches): the slot conversation, upload, resume, commit, progress. - [Look up a single image](/docs/xio/parallax/rest-api/look-up-single-image): one image in, one verdict out. - [Look up in batches](/docs/xio/parallax/rest-api/look-up-in-batches): the look-up slot conversation and its results. - [Recover an image's attribution](/docs/xio/parallax/rest-api/records): the manifests for any image you have found, whoever registered it. - [Manifests](/docs/xio/parallax/rest-api/manifests): what a manifest is here, how to state one, and what comes back. - [Take down a registration](/docs/xio/parallax/rest-api/take-down): stop an image matching. - [Quotas and stats](/docs/xio/parallax/rest-api/quotas-and-stats): what you are granted, what spends it, and how to read your usage. - [Custody and privacy](/docs/xio/parallax/rest-api/custody-and-privacy): what happens to your pixels, what is stored, and what another account can learn. - [Errors and refusals](/docs/xio/parallax/rest-api/errors-and-refusals): every status and every refusal reason, with what to do about each. - [REST API reference](/docs/xio/parallax/rest-api/reference): the endpoint by endpoint contract.