Autonnel v1.7.0

External endpoints

Per-resource summary of the /api/v1.1/* surface: domains, pages, funnels, orders and products, with the scopes each endpoint requires.


Each section below documents one resource group under /api/v1.1/*. Authentication applies to every endpoint — see API overview for the Authorization header format.

For AI agent integrations, most of these operations are also exposed as MCP tools — see MCP server, which also lists the seven tools that have no REST equivalent and the endpoints that share a path with a tool but not its shape.

Permission levels used in this page:

  • Read — requires a valid API key (any key).
  • Write — requires a key with writeAccess enabled.

Ads

Ad platform configurations (Facebook, TikTok, Bing Ads) linked to your deployment.

MethodPathDescriptionAccess
GET/api/v1.1/adsList all ad platforms.Read
GET/api/v1.1/ads/:idGet a single ad platform by ID.Read
# List all ad platforms
curl -H "Authorization: Bearer YOUR_KEY" \
  https://your-shop.com/api/v1.1/ads

# Get one platform
curl -H "Authorization: Bearer YOUR_KEY" \
  https://your-shop.com/api/v1.1/ads/clxyz123

Domains

Custom domains bound to the deployment and their per-domain settings, the same as Pages → Domains. All methods run the matching MCP tools through the shared bridge and require a key granted the Settings: Domains feature (SETTINGS_DOMAINS). Adding a domain only records the host; DNS and TLS for it must already point at the deployment (see Domains).

MethodPathDescriptionAccess
GET/api/v1.1/domainsList domains (list_domains): { domains: [{ id, domain, isPrimary }], count }.Read
POST/api/v1.1/domainsAdd a domain (add_domain). Body { "domain": "shop.example.com", "isPrimary": false }. Returns 201, or 409 if the host is already bound.Write
DELETE/api/v1.1/domains/:domainRemove a domain by id or hostname (remove_domain). Returns 404 if it is not bound.Write
GET/api/v1.1/domains/:domainRead the domain’s settings (get_domain_settings): brand (storeName, logoUrl, faviconUrl, fromEmail, fromName, replyTo, timeZone, noindex), staticSubdomain, storage and email (its sending provider). Secrets come back masked.Read
PATCH/api/v1.1/domains/:domainChange the brand (update_domain). Only the fields sent change; null clears one. isPrimary: true makes it the fallback default domain.Write
PUT/api/v1.1/domains/:domain/storageSet or remove (null) the domain’s S3-compatible storage (set_domain_storage). Verified with a real upload before saving.Write
PUT/api/v1.1/domains/:domain/emailSet the sending provider (set_domain_email_provider): CLOUDFLARE, RESEND, SES, or null to fall back to the shared configuration. Omitted secrets keep the stored ones.Write
PUT/api/v1.1/domains/:domain/paymentBind a payment account to the domain for its provider, or unbind with accountId: null (set_domain_payment_account). Body { "provider": "STRIPE", "accountId": "...", "settings": {} }; provider is the provider key and settings holds the binding fields. The key needs the Settings: Payment feature (SETTINGS_PAYMENT) instead of Domains. Failures carry a code: MISSING_FIELD: siteId, ACCOUNT_NOT_FOUND, PROVIDER_MISMATCH, ACCOUNT_INACTIVE. Accounts cannot be created through the API. Reads of the domain (get_domain_settings) include the payment bindings, never credentials.Write
POST/api/v1.1/domains/:domain/email/testSend a test email (send_domain_test_email). Body { "to": "you@example.com" }. A delivery failure returns 200 with { ok: false, error }.Write

To set a logo or favicon, upload the image with POST /api/v1.1/media/upload and pass the returned https url as logoUrl or faviconUrl. Custom code is not exposed through the API.

The first domain added becomes the fallback default (isPrimary) automatically. Removing the fallback default domain does not promote another one.

# Add a domain
curl -X POST \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "shop.example.com"}' \
  https://your-shop.com/api/v1.1/domains

# Brand it and send through Amazon SES
curl -X PATCH \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"storeName": "Example Shop", "fromEmail": "orders@shop.example.com", "faviconUrl": "https://static.example.com/favicon.png"}' \
  https://your-shop.com/api/v1.1/domains/shop.example.com

curl -X PUT \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider": "SES", "region": "us-east-1", "accessKeyId": "AKIA...", "secretAccessKey": "..."}' \
  https://your-shop.com/api/v1.1/domains/shop.example.com/email

# Remove it by hostname
curl -X DELETE \
  -H "Authorization: Bearer YOUR_KEY" \
  https://your-shop.com/api/v1.1/domains/shop.example.com

Discovering tools

GET /api/v1.1/tools (any key, read access) returns every MCP tool with its REST method, path, description, writeAccess, requiredFeature and inputSchema (JSON Schema). Path parameters such as :pageId fill the argument of the same name; GET arguments go in the query string (repeat a key for arrays), other methods take a JSON body.


Funnels

Every endpoint except GET /funnels/:funnelId/pages runs the MCP tool named in its row through the shared bridge: same input, same response, same errors. Query-string values are converted to the tool’s types (?page=2 is a number).

MethodPathToolAccess
GET/api/v1.1/funnelslist_funnels (page, limit)Read
GET/api/v1.1/funnels/:funnelIdget_funnelRead
POST/api/v1.1/funnelscreate_funnel. Returns 201.Write
PUT/api/v1.1/funnels/:funnelIdupdate_funnelWrite
DELETE/api/v1.1/funnels/:funnelIddelete_funnelWrite
POST/api/v1.1/funnels/:funnelId/pagesadd_funnel_page. Returns 201.Write
PUT/api/v1.1/funnels/:funnelId/pagesreplace_funnel_pageWrite
PATCH/api/v1.1/funnels/:funnelId/pagesset_funnel_step_slugWrite
DELETE/api/v1.1/funnels/:funnelId/pagesremove_funnel_pageWrite
GET/api/v1.1/funnels/:funnelId/pagesREST only: the funnel’s referenced pages that are PUBLISHED ({ pageId, slug, name, type, stepSlug }).Read
curl -H "Authorization: Bearer YOUR_KEY" \
  "https://your-shop.com/api/v1.1/funnels?page=1&limit=20"

curl -H "Authorization: Bearer YOUR_KEY" \
  https://your-shop.com/api/v1.1/funnels/clxyz789

Example GET /api/v1.1/funnels/:funnelId response:

{
  "id": "clxyz789",
  "name": "Summer Sale",
  "description": null,
  "createdAt": "2026-06-01T08:00:00.000Z",
  "updatedAt": "2026-06-18T12:00:00.000Z",
  "entryStepSlug": "landing",
  "steps": [
    {
      "stepSlug": "landing",
      "pageId": "p_lp1",
      "page": { "id": "p_lp1", "slug": "summer", "name": "Summer LP", "type": "custom", "status": "PUBLISHED" }
    },
    {
      "stepSlug": "checkout",
      "pageId": "p_co",
      "page": { "id": "p_co", "slug": "checkout", "name": "Checkout", "type": "checkout", "status": "PUBLISHED" }
    }
  ]
}

A step whose page was deleted keeps page: null. An unknown funnelId returns 404.


Media

MethodPathDescriptionAccess
POST/api/v1.1/media/upload-urlupload_media: body { "url": "https://..." }, the server downloads it and returns { assetId, url }. Returns 201.Write
POST/api/v1.1/media/uploadREST only: upload a local file as multipart/form-data with a file part. Returns 201 with { assetId, url }.Write

Both accept image/jpeg, image/png, image/webp, image/gif, video/mp4 and video/webm. Without storage configured they return 412 naming Settings → Storage.

curl -X POST -H "Authorization: Bearer YOUR_KEY" \
  -F "file=@/path/to/image.jpg" \
  https://your-shop.com/api/v1.1/media/upload

curl -X POST -H "Authorization: Bearer YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/image.jpg"}' \
  https://your-shop.com/api/v1.1/media/upload-url

Orders

Customer data is privacy-protected: email addresses are masked, and addresses expose country only.

MethodPathToolAccess
GET/api/v1.1/orderslist_orders (status repeatable, search, startDate, endDate, domain, page, limit)Read
POST/api/v1.1/orders/:orderId/deliverdeliver_orderWrite

deliver_order marks the order DELIVERED and sends the delivery email. It returns { "changed": true, "state": "DELIVERED" }, 404 for an unknown order, and 409 when the order’s state does not allow it (not yet paid, already delivered, refunded); the error message names the current state.

curl -H "Authorization: Bearer YOUR_KEY" \
  "https://your-shop.com/api/v1.1/orders?status=PAID&status=SHIPPED&startDate=2026-01-01"

curl -X POST -H "Authorization: Bearer YOUR_KEY" \
  https://your-shop.com/api/v1.1/orders/12345/deliver

Pages

MethodPathToolAccess
GET/api/v1.1/pageslist_pages (search, type, status, domainId, page, limit)Read
GET/api/v1.1/pages/:pageIdget_pageRead
POST/api/v1.1/pagescreate_page. Returns 201.Write
PUT/api/v1.1/pages/:pageIdupdate_pageWrite

GET /pages lists drafts and published pages alike; pass status=PUBLISHED for live pages only. GET /pages/:pageId returns both draftData (work in progress) and publishedData (live), plus htmlContent / draftHtml for HTML pages; read it before editing so you keep props you did not author. PUT replaces draftData wholesale and publishes only when the body contains "publish": true. There is no page DELETE.

curl -H "Authorization: Bearer YOUR_KEY" \
  "https://your-shop.com/api/v1.1/pages?status=PUBLISHED&search=summer"

curl -H "Authorization: Bearer YOUR_KEY" \
  https://your-shop.com/api/v1.1/pages/clxyz456

Example GET /api/v1.1/pages/:pageId response (trimmed):

{
  "id": "clxyz456",
  "name": "Checkout",
  "slug": "my-checkout",
  "type": "checkout",
  "status": "PUBLISHED",
  "editorType": "PUCK",
  "domains": [{ "id": "d1", "host": "shop.example.com", "isPrimary": true, "isDefault": true }],
  "draftData": { "content": [], "root": {} },
  "publishedData": { "content": [], "root": {} },
  "htmlContent": null,
  "draftHtml": null,
  "meta": {},
  "publishedAt": "2026-06-18T12:00:00.000Z"
}

Page templates

MethodPathToolAccess
GET/api/v1.1/page-templateslist_templatesRead
GET/api/v1.1/page-templates/:keyget_templateRead

/api/v1.1/templates and /api/v1.1/templates/:key are email templates (REST only, Email settings permission), not page templates.


Products

Products are read from the connected ecommerce adapter (Shopify, WooCommerce, or Picocart). Manage products in your ecommerce platform.

MethodPathToolAccess
GET/api/v1.1/productslist_products (search, limit up to 250). Returns { products, count }.Read
curl -H "Authorization: Bearer YOUR_KEY" \
  "https://your-shop.com/api/v1.1/products?search=shirt"

Without a connected ecommerce backend this returns 400 with a message naming Settings → E-commerce.


Analytics

All funnel metrics are counted by unique user, not page views.

MethodPathDescriptionAccess
GET/api/v1.1/analyticsget_stats (funnelId, startDate, endDate, timezone; last 30 days by default). Returns { stats, query }.Read
GET/api/v1.1/analytics/paymentsREST only: checkout micro-funnel, payment errors and per-provider success rates.Read
GET/api/v1.1/analytics/trendREST only: daily trend.Read
GET/api/v1.1/analytics/segmentsREST only: breakdown by dimension.Read
GET/api/v1.1/analytics/experimentsREST only: A/B arms.Read

The REST-only analytics endpoints take the same funnelId, startDate, endDate and timezone query parameters and require funnelId.

curl -H "Authorization: Bearer YOUR_KEY" \
  "https://your-shop.com/api/v1.1/analytics?funnelId=clxyz789&startDate=2026-06-01&endDate=2026-06-30"

Changed

  • Every MCP tool is now also a REST endpoint running the same handler, so the two surfaces return the same data. GET /funnels, GET /funnels/:funnelId, GET /pages, GET /pages/:pageId, GET /products, GET /analytics and POST /orders/:orderId/deliver changed shape to match their tools: no funnel / page wrapper, id instead of funnelId / pageId, list endpoints are paginated, GET /pages includes drafts (filter with status=PUBLISHED), page detail returns draftData and publishedData instead of document / html, products are searched with search instead of q, analytics returns stats instead of success / data, and delivering an order that cannot be delivered returns 409 instead of 200 with changed: false.

Caveats

  • Response field stability is not guaranteed before v1. Pin against a specific autonnel release in production integrations.
  • All responses are JSON. Bridged endpoints fail with { "error": "message" } (plus issues[] for invalid arguments) and an HTTP status: 400 invalid input, 401 missing or bad key, 403 missing permission or write access, 404 not found, 409 conflict, 412 storage not configured.
  • API keys — generate and manage API keys.
  • MCP server — the agent-facing surface, and where it diverges from these endpoints.
  • API overview — authorization model and write access.