OpenAPI as source
Methods, paths and operation descriptions come from the downloadable OpenAPI contract.
Capability
REST API reference
Browse the authenticated API surface for accounts, Cloud resources, folders, transformations, users and webhooks.
Overview
The browsable reference is generated from the same OpenAPI 3.1 contract used by client generators and integration tests.
OpenAPI 3.1
Download OpenAPI 3.1REST API reference
Browse the authenticated API surface for accounts, Cloud resources, folders, transformations, users and webhooks.
| HTTP | Path | Overview |
|---|---|---|
| GET | /auth/me | Returns the authenticated user and safe API key metadata. |
| GET | /account | Returns account, reseller, subscription and effective Cloud settings. |
| PATCH | /account | Updates the basic account details. |
| GET | /account/stats | Returns service, storage, version and view totals. |
| GET | /cloud/settings | Returns the Cloud settings available to the authenticated role. |
| PATCH | /cloud/settings | Updates global Cloud settings or the subaccount baseline according to the role. |
| GET | /cloud/catalog | Returns the allowed service, extension and upload-app catalog. |
| GET | /cloud/services | Returns a paginated list of Cloud services. |
| POST | /cloud/services | Creates an editable Cloud service. |
| POST | /cloud/files | Uploads a file after validating its extension, detected MIME, size and default app. |
| GET | /cloud/services/{code} | Returns the details of a Cloud service. |
| PATCH | /cloud/services/{code} | Updates the name, visibility, payload, folder or tags. |
| DELETE | /cloud/services/{code} | Moves a Cloud service to the recycle bin. |
| GET | /cloud/services/{code}/content | Downloads the original file or a result with authentication. |
| GET | /cloud/services/{code}/thumbnail | Returns Cloud services. |
| GET | /cloud/services/{code}/stats | Returns views, referrers and recent service activity. |
| POST | /cloud/services/{code}/move | Moves a Cloud service to another folder. |
| GET | /cloud/folders | Returns the accessible folders. |
| POST | /cloud/folders | Creates a folder. |
| PATCH | /cloud/folders/{id} | Renames, moves or changes the visibility of a folder. |
| DELETE | /cloud/folders/{id} | Moves a folder and its contents to the recycle bin. |
| GET | /file-transformer/operations | Lists all 154 public operations with their formats and parameters. |
| GET | /file-transformer/operations/{operation} | Returns the contract for a specific operation. |
| POST | /file-transformer/estimates | Validates the input and estimates credits before execution. |
| GET | /file-transformer/jobs | Returns the account’s asynchronous transformation jobs. |
| POST | /file-transformer/jobs | Creates and queues a transformation. |
| GET | /file-transformer/jobs/{id} | Returns the status, progress, usage and results of a job. |
| POST | /file-transformer/jobs/{id}/cancel | Cancels a job that is still queued. |
| POST | /file-transformer/jobs/{id}/retry | Creates a new attempt from a failed or cancelled job. |
| GET | /users | Admins list users; resellers list their subaccounts. |
| POST | /users | Creates a user or subaccount. |
| GET | /users/{id} | Returns the details of a manageable user. |
| PATCH | /users/{id} | Updates a manageable user. |
| PATCH | /users/{id}/cloud-settings | Customizes Cloud settings for a manageable user. |
| GET | /webhooks | Returns the account’s webhook endpoints. |
| POST | /webhooks | Creates a universal webhook endpoint. |
| GET | /webhooks/{id} | Returns the details of a webhook endpoint. |
| PATCH | /webhooks/{id} | Updates the URL, events or status, or rotates the secret. |
| DELETE | /webhooks/{id} | Deletes a webhook endpoint. |
| POST | /webhooks/{id}/test | Queues a test delivery to the endpoint. |
| GET | /webhooks/{id}/deliveries | Returns a paginated delivery history for an endpoint. |
| POST | /webhook-deliveries/{id}/retry | Manually requeues a webhook delivery. |
| GET | /ai/providers | Lists AI providers. |
| POST | /ai/estimates | Creates AI estimates. |
| GET | /ai/text/generations | Lists AI text generations. |
| POST | /ai/text/generations | Creates AI text generations. |
| GET | /ai/media/generations | Lists AI media generations. |
| POST | /ai/media/generations | Creates AI media generations. |
| GET | /plans | Lists plans. |
| POST | /plans/custom/estimates | Creates plans custom estimates. |
| GET | /billing/usage | Returns billing usage. |
| GET | /billing/credit-consumptions | Lists billing credit consumption. |
| GET | /billing/tariffs | Lists billing tariffs. |
| GET | /billing/subscription | Returns billing subscription. |
| POST | /billing/subscriptions/plan/{plan} | Creates billing subscriptions. |
| POST | /billing/subscriptions/custom | Creates billing subscriptions custom. |
| POST | /billing/subscriptions/{subscription}/renew | Renews billing subscriptions. |
| DELETE | /billing/subscriptions/{subscription} | Deletes billing subscriptions. |
| GET | /billing/transactions | Lists billing transactions. |
| GET | /billing/transactions/{id} | Returns billing transactions. |
| POST | /billing/transactions/{id}/cancel | Cancels billing transactions. |
| POST | /billing/transactions/{id}/retry | Retries billing transactions. |
| POST | /billing/transactions/{id}/reconcile | Reconciles billing transactions. |
| GET | /billing/invoices | Lists billing invoices. |
| GET | /billing/invoices/{invoice} | Returns billing invoices. |
| GET | /billing/invoices/{invoice}/pdf | Returns billing invoices. |
| GET | /cloud/services/{code}/versions | Lists Cloud versions. |
| GET | /cloud/services/{code}/versions/{version}/download | Returns Cloud versions. |
| POST | /cloud/services/{code}/versions/{version}/restore | Restores Cloud versions. |
| GET | /cloud/services/{code}/permissions | Returns Cloud services permissions. |
| PUT | /cloud/services/{code}/permissions | Updates Cloud services permissions. |
| GET | /cloud/folders/{folder}/permissions | Returns Cloud folders permissions. |
| PUT | /cloud/folders/{folder}/permissions | Updates Cloud folders permissions. |
| GET | /cloud/imports/providers | Lists Cloud imports providers. |
| GET | /cloud/imports/connections | Lists Cloud imports connections. |
| GET | /cloud/imports/{provider}/authorization | Returns Cloud imports authorization. |
| POST | /cloud/imports/{provider}/connections | Creates Cloud imports connections. |
| DELETE | /cloud/imports/connections/{provider} | Deletes Cloud imports connections. |
| GET | /cloud/imports/{provider}/browse | Returns Cloud imports. |
| POST | /cloud/imports/{provider}/jobs | Creates Cloud imports. |
| GET | /cloud/import-jobs | Lists Cloud import jobs. |
| GET | /cloud/import-jobs/{job} | Returns Cloud import jobs. |
| GET | /cloud/services/{code}/survey/responses | Lists Cloud survey responses. |
| GET | /cloud/services/{code}/poll/results | Returns Cloud poll results. |
| GET | /cloud/services/{code}/event/attendees | Lists Cloud event attendees. |
| PATCH | /cloud/services/{code}/event/attendees/{attendee} | Updates Cloud event attendees. |
| GET | /cloud/services/{code}/signature/tracking | Returns Cloud signature tracking. |
| GET | /marketplace/services | Lists marketplace services. |
| GET | /marketplace/services/{service} | Returns marketplace services. |
| POST | /marketplace/services/{service}/installations | Creates marketplace installations. |
| DELETE | /marketplace/services/{service}/installations | Deletes marketplace installations. |
| POST | /marketplace/installations/{installation}/launch | Launches marketplace installations. |
| GET | /marketplace/partner/services | Lists marketplace partner services. |
| POST | /marketplace/partner/services | Creates marketplace partner services. |
| PUT | /marketplace/partner/services/{service} | Updates marketplace partner services. |
| DELETE | /marketplace/partner/services/{service} | Deletes marketplace partner services. |
| POST | /marketplace/partner/services/{service}/submit | Returns marketplace partner services. |
Features
What REST API reference can do
Scoped authentication
Every protected operation identifies the least-privilege scope required by its route.
Safe write retries
Idempotency keys protect supported writes against accidental duplication after network retries.
Asynchronous transformations
Create, estimate, monitor, cancel and retry File Transformer jobs.
Signed event delivery
Create webhook endpoints, inspect deliveries and retry transient failures.
Explicit functional scope
Specialized editors, survey responses, attendee management, signatures and AI generation are not implied unless an endpoint is listed.
Frequently asked questions
Questions about REST API reference
No. The reference is the authoritative list; unlisted editor and service-specific operations remain account-interface workflows.
Yes. The OpenAPI 3.1 JSON remains available for generators, validation and local tooling.
Use a narrowly scoped API key and an idempotency key for supported write operations.