API reference

Browse the stable public API for production integrations, inspect schemas, and try requests without leaving the docs.

Authentication

Use a bearer token from your account settings when testing secured endpoints.
Authorization: Bearer sk_live_YOUR_API_KEY

Manage keys from Account Settings.

Coverage

This viewer is driven directly from the public OpenAPI spec.
70 public operations
9 API groups

It is ideal for production integrations, including the tool-facing REST surface used by ChatGPT Actions, MCP clients, webhooks, and external automations.

Spec artifacts are published at YAML and JSON.

Additional app capabilities graduate into the public spec as API shapes stabilise, authentication rules are documented, and publish behavior has clear visible-outcome and audit semantics.

Popular automations

Use the public API for catalog and approval workflows that need a stable integration surface.
  • Catalog readiness audit
  • Batch image cleanup
  • Supplier upload intake
  • Approval handoff
  • Shopify publish preparation
  • Webhook status reporting

API safety classes

Capability gates separate preview reads from actions that can create work, approve assets, or affect a live storefront.

Preview-safe reads

Read catalog readiness, job status, assets, and approval context without mutating store data.

Controlled mutations

Create jobs, submit assets, or update approvals with authenticated keys and explicit workspace permissions.

Publish-sensitive actions

Operations that affect Shopify delivery stay behind stronger capability checks and audit logs.

Public API graduation checklist

Capabilities move from internal app routes to the public API only when the integration contract is ready for production users.
  • API status: stable / beta / internal
  • Rate limits by plan
  • Idempotency examples
  • Webhook signing examples
  • Retry behavior
  • Error taxonomy

Swagger explorer

Browse the public contract through a first-party API console with editable request bodies, bearer auth, and live responses.

Set auth once, then work directly in the explorer
Choose a server, keep a bearer token handy, and filter the public endpoints down to the one you want to test.
Bearer token
Authorization

Bearer token header

Server picker

Switch between spec targets

Try it out

Run requests in the page

Spec source
/openapi.yaml

The console below is rendered from the public spec, not from handwritten mock docs.

Request editor and live response output
Expand an endpoint, edit the JSON body, execute the request, and inspect the server response without leaving the docs page.
Loading the public API spec
Loading the API specification into the console.