Developer overview

A high-level map of what your agent can do with Epox. To connect one, start with Connecting an MCP client.

What's available

Epox has no public REST API for reading or generating workspace data.

Programmatic access goes through the Epox MCP server:

• It is a single Model Context Protocol endpoint.
• Claude, Codex, and other MCP clients can use it.
• Each tool is documented on its own page, with a description beside a request and response example.

Read tools

There are 23 read tools. They let an agent look at your workspace without changing it.

• Workspace and try-on — workspace summary, credits and usage, store connection, try-on analytics. See Workspace & try-on.
• Catalogue — products, collections, generated assets, and the image and video models you can use, with a ranked recommendation for a goal. See Catalogue.
• Generation and automations — template packs, Studio sessions, jobs, and automations. You can wait on up to 12 jobs in one call. See Generation & automations.

Write tools

There are 25 write tools. They add to your workspace or start work. All of them are on Generation & automations.

Set up

• epox_add_product_photo adds a photo to a product to generate from; epox_add_reference_image adds one to take style from.
• epox_create_product creates a product.
• epox_prepare_image_upload gives a one-time upload URL for a local file.
• epox_create_session creates a Studio session, a named group for one run's outputs. It is free and starts nothing.

Generate

These may spend credits. Each accepts dryRun to price the work first.

• epox_start_generation starts a queued run from looks you describe.
• epox_start_pack_generation starts a queued run from a saved pack.
• epox_generate_image and epox_generate_images make images from prompts, up to 12 at once.
• epox_start_video and epox_start_videos render clips, up to 12 at once.

Edit

These may spend credits. Each accepts dryRun, and saves the result as a new asset.

• epox_remove_background removes the background from an image.
• epox_upscale_image upscales an image.

Sessions and automations

These change what you already have. Deleting never removes your images.

• epox_update_session renames, pins or hides a session; epox_delete_session removes the session and keeps its images.
• epox_create_automation, epox_update_automation and epox_set_automation_enabled write an automation as the automation editor does. An automation with a store trigger spends credits on every matching product with nobody watching, so these need a dry run and its confirmToken first.
• epox_run_automation runs one now on up to 50 products and spends credits; epox_cancel_automation_run stops a run; epox_delete_automation removes an automation and keeps its runs' images.

Plan, check, and join

These are free.

• epox_direct plans a storyboard.
• epox_check_asset judges a finished image's quality.
• epox_analyze_image scores any image for realism, technical quality, and composition, and lists its defects.
• epox_combine_videos joins 1 to 12 clips into one video.

The generation and combine tools take an optional flowId to file their results in a flow. From an idea to a finished ad shows them chained together.

Connecting

• Agents connect by signing in. Add the server URL, then an owner approves the connection in the browser.
• There is no key to store.
• Settings → MCP shows the steps for each client and lists approved connections.
• Settings → API Keys is for scripts and CI.

Scopes

Each credential, meaning an OAuth connection or an API key, carries scopes that an owner chose when approving or creating it.

• `mcp:read` covers every read tool.
• `mcp:generate` is needed in addition for all 25 write tools.

To grant generation access:

• On an OAuth connection, click Allow generation access on the consent screen. It is requested by default.
• On an API key, check Allow generation.

Calling a tool outside your scopes fails:

• With an API key, the error says to create a key with Allow generation.
• With an OAuth connection, the server answers HTTP 403 with WWW-Authenticate: Bearer error="insufficient_scope" and the scopes to request, so the client can sign in again.

Next steps

• Connecting an MCP client to create a key and add the server.
• Requests, responses & errors for the request format, pagination, rate limits, and error codes.
• Workspace & try-on tools, Catalogue tools, and Generation & automations tools for each tool's arguments and examples.