Imazeo API documentation
Start with one authenticated request. Learn the media workflows, then build a secure integration with the detailed API and SDK references.
Start here
- Create an account and complete email verification if required.
- Create a project, then open API keys and select that project. Copy the key once and keep it on your server.
- Follow your first request, then run the image quickstart or choose a PDF/code operation below. Check your assigned limits before running requests.
Portal setup links open in a new tab. Existing customers can sign in and continue from their workspace.
1. Start with a project key →Verify project context without a file or processing credit.Your first transformation →Terminal and Node.js examples take an original to a 600 × 600 WebP.Work with PDFs →Inspect, render, merge or extract with authenticated multipart requests.Generate QR codes & barcodes →Receive PNG or SVG bytes for a link or label.
API reference
Start building
- Getting started →
- Create a project, verify your API key and choose your first media operation. Start with a request that needs no upload or processing credit.
- Your first image transformation →
- Upload an original and create a square WebP using a project API key. These examples run in your terminal or on your server.
- Authentication and API keys →
- Choose customer authentication for account management and project API keys for server integrations.
- Projects & API keys →
- Create projects, issue server-side credentials and revoke access. Management endpoints require a customer
bearertoken. - SDKs & language support →
- Choose a server-side integration approach. Six Imazeo SDKs are prepared for release; use the HTTP examples while package publication is pending.
Media APIs
- Images API →
- Upload, list, inspect, download and delete project-owned originals. Uploaded bytes and embedded metadata are preserved.
- Transformations API →
- Resize, crop and convert an uploaded image or a remote source enabled for your account. Choose effects, output format and storage mode.
- PDF tools →
- Inspect, render, merge and extract PDFs with authenticated multipart requests. Outputs are ephemeral and consume processing credits.
- QR codes & barcodes →
- Choose a QR code for text or links, or a supported barcode for labels. Both APIs return PNG or SVG bytes and consume one credit per generation.
- QR code API →
- Encode an event link, text or another payload into a static PNG or SVG QR code. Choose size, quiet zone, colors and error correction.
- Barcode API →
- Generate PNG or SVG labels for inventory and packaging. Select a supported symbology and keep identifiers as strings to preserve leading zeros.
- Saving & retrieving outputs →
- Understand temporary generation, optional private saved artifacts and later downloads. Saving media is a separate request from generating it.
Build for production
- Common workflows →
- Combine the implemented APIs into product imagery, document packets and event labels. Track resource IDs, response types and retention deliberately.
- Secure API integration →
- Keep project keys on your server, enforce your own user permissions and deliver private media through a controlled application boundary.
- Production best practices →
- Bound concurrency, manage private output retention and recover safely from failures. Plan around actual account limits and buffered client responses.
- Troubleshooting →
- Diagnose authentication, upload, output and quota failures before retrying. Use the HTTP status, API error code and sanitized request ID together.
Reference
- API reference →
- Browse reviewed project, image, PDF, code, artifact and usage operations. Download the curated OpenAPI contract for developer tooling.
- Limits and usage →
- Your assigned plan and deployment limits both apply. Check credits, storage, bandwidth and per-request limits before processing files.
- Errors and recovery →
- Diagnose a failed request using its HTTP status, error code and request ID. Some successful responses contain files; errors use a JSON envelope.
Account & site
- Account & support →
- Understand the customer account endpoints around your integration: profile, sessions, support, subscriptions and usage.
- Public configuration & contact →
- Read public availability flags and submit a website inquiry without customer or project credentials. Processing APIs remain authenticated.
Jump to transformation parameters, remote sources or usage accounting.
Integration resources
- Download developer OpenAPI (JSON) for operation schemas, authentication and response types. Read the API reference for scope and limitations.
- Machine-readable documentation index (llms.txt) links to these guides, SDK resources and product policies.
- Request builder: configure QR, barcode or PDF options locally and copy a command. No API key or file is collected.
- Image recipes: product thumbnails and responsive variants.
- Product FAQ for workspace/API use, private delivery and where to start.
- Contact & account support for help beyond the guides.
Contract scope
Documentation reviewed 2026-10-03 against development backend commit e298ec7, including controller OpenAPI annotations, request validation, services and error mapping. The local Swagger snapshot is bundled for type generation and schema tables. Deployment compatibility still requires validation against your API origin.
Examples use cURL and built-in Node.js fetch. See SDKs & language support for release availability and scope. Check your deployment’s API origin and account limits before running requests.