PhotoDeck APIs & integrations
Connect your applications to PhotoDeck media libraries and websites, from managing metadata and uploads to publishing galleries.
PhotoDeck exists to help you save time, and that includes keeping it in sync with your workflows and environments.
At a glance
- Manage media, uploads, galleries and more from your own systems.
- Extensive backend JSON API with OAuth 2.0/2.1, agent-ready, OpenAPI specification.
- API access is included in PhotoDeck subscriptions, within fair use.
Three ways to integrate PhotoDeck
AI chatbot connectors
Official connectors let you drive a PhotoDeck account from an AI chatbot like ChatGPT, Claude, Mistral or Grok, using everyday language and no development work. Learn more ›
Backend API
For custom applications and to integrate PhotoDeck accounts with real-life business environments, developers and their AI coding agents build with the Backend API.
Public website indexing
An external frontend, for example a stock aggregation service, can read the published media of a PhotoDeck website through an XML index.
The Backend API
Integrate PhotoDeck into your systems
The Backend API gives your applications direct access to your PhotoDeck account, with all the rights of the users you connect to, including media libraries, galleries, uploads, metadata…
Access is included in PhotoDeck subscriptions, within the normal and fair use of the account and its subscription level (see Acceptable Use). Contact us to discuss your project!
Developer-friendly, agent-ready
Everything you need for your first API call
The Backend API documentation covers the service in depth, and it designed to make work easy for both developers and their AI coding agents:
- Standard authentication: OAuth 2.0/2.1 authorization code flow with PKCE. Users sign in to PhotoDeck in their browser, not in your application.
- Predictable JSON resources: consistent conventions for requests, responses, errors, pagination, redirects and background jobs.
- Agent-optimized formats: besides HTML, the documentation is available as Markdown and as an OpenAPI specification.
Public website content indexing
Feed another frontend from a PhotoDeck site
The public content of a PhotoDeck website (images, videos, documents) can be exposed as a single XML file, ready to be integrated into another frontend or website, for example a stock aggregation service.
- The website owner activates the export and provides an authentication token; no login credentials are ever required.
- Protected content is excluded: hidden galleries and password- or login-protected galleries never appear in the file.
- The file refreshes automatically; clients should fetch it conditionally with If-Modified-Since requests.
FAQ
Do I need the API to automate everyday tasks in a PhotoDeck account?
No. Official connectors let AI chatbots like ChatGPT or Claude work on a PhotoDeck account in everyday language, without any development. The Backend API is meant for building applications and deeper integrations.
What can I do through the Backend API?
The Backend API works among other objets on the medias, libraries and websites of an account, from reading metadata to uploading files and publishing galleries. The documentation’s endpoint reference is the complete list of endpoints. Some endpoints and writable fields depend on the account’s subscription level (for example access to orders requires a plan with the “Business API” feature), please refer to the documentation.
Does API access cost anything extra?
Access comes with every PhotoDeck subscription, on a fair-use basis monitored by PhotoDeck. The Acceptable Use policy in the documentation lists what counts as abuse. Processing-intensive or bandwidth-hungry operations, like those involving file transfers, might count towards the account’s microjobs limit as indicated in the relevant endpoints’ documentation.
How do I authenticate against the Backend API?
The API uses the OAuth 2.0/2.1 authorization code flow with PKCE, then a bearer access token on every request. Password authentication and browser-session cookies are not supported.
Can I use AI coding agents to build with the PhotoDeck API?
Yes. The documentation is published as Markdown and as an OpenAPI specification to help AI coding agents find supported endpoints and build an integration, for example to upload files, manage their metadata, or publish galleries. The application still needs registration and OAuth authorization.
Do I need approval before building on the API?
No, but we encourage you to discuss your project with us so we can make sure the integration is suitable for the intended use.