01 Fundamentals

What is a REST API?

An API (Application Programming Interface) is an interface made up of clearly defined HTTP calls through which two systems exchange data — with no user interface and no manual clicking. Instead of logging in to pixx.io and editing files by hand, your own program sends a request like "give me all files with the keyword Summer" or "set the status of file 48213 to approved" — and gets a structured response back.

The four common HTTP methods cover almost everything: GET to read, POST to create, PUT to update, DELETE to delete.

02 Capabilities

What can you do with it?

The pixx.io API covers practically every object in the Mediaspace:

Files

Upload, search, download, read and write metadata, manage versions.

Collections & shares

Create and maintain collections, create and manage external shares (share links).

Rights & users

Centrally control permission groups, user accounts and permissions.

Licenses & releases

Manage license, model and property releases and check expiry dates.

Downloads & formats

Retrieve predefined download formats (renditions) and direct links.

Keywords & synonyms

Keyword and synonym management for consistent tagging.

Typical use scenarios: automatic image import from a PIM/ERP, metadata sync with a shop or CMS system, reporting via your own dashboards, or writing back AI-generated results from an automation.

03 Access

Authentication

Access is via personal API keys, which you create with a defined scope, assign to a user and can optionally restrict to a specific IP range. That way, even with multiple integrations, you keep track of which key is used for what — and you can deactivate individual keys at any time without affecting other integrations.

bash · curl

curl "https://<yourMediaspaceUrl>/..." \
  -H "Authorization: Bearer YOUR_API_KEY"

The exact endpoints, parameters and the precise authentication scheme are defined authoritatively in the official API documentation — this curl call only shows the basic principle.

04 Working together

API + webhooks: the complete loop

A webhook alone only delivers information — the real automation only emerges in combination with the API. The webhook tells you "this just happened", the API lets you react: fetch a file, update metadata, write a result back.

🔁

Push (webhook) informs you in real time. Pull & write (API) lets you read and change. Most integrations need both. Details in the webhook documentation and the automation overview.

Ready for your first request?

You'll find all endpoints, parameters and example requests in the complete API reference.

Go to the API documentation → Webhooks Automation Plugin SDK