Skip to main content
The Bily API gives your backend services and trusted workflows a versioned interface to Bily. Every endpoint is authenticated and every store request is checked against the caller’s organization access. Use the API to:
  • discover the organizations and stores available to a key;
  • query advertising, attribution, product, customer, and cohort analytics;
  • inspect store readiness, connected accounts, assets, and tracking connections;
  • run read-only store commerce queries;
  • synchronize supported connections and perform explicit platform actions.

​
Base URL

All stable customer endpoints share this base URL: 
https://app.bily.ai/api/customer/v1
The /v1 segment is part of the contract. Do not omit it.

​
Start with discovery

Start with one request when you do not already know the organization and store:
  1. GET /context returns the authenticated user, accessible organizations, and each organization’s nested stores.
  2. Use an exact organizations[].stores[].url value in store-scoped endpoints.
  3. Add the optional organizationId query only when the identity can access multiple organizations and the workload explicitly selects one. A store-scoped API key needs no parameter.
GET /me, GET /organizations, and GET /stores remain available when a workload needs one focused part of the discovery response.

Authentication

Create, store, send, and revoke an API key safely.

Scoping

Understand organization and store access boundaries.

API quickstart

Make a request and list your first store.

Errors and request IDs

Handle failures and preserve diagnostic context.

​
Response format

Successful responses are JSON. Resource collections use a named object when the contract needs context, such as { "stores": [...] }, or an array for analytics rows. Every response includes an x-request-id header. Preserve it in logs and support requests.
The endpoint reference is generated from Bily’s OpenAPI specification. The specification is the source of truth for paths, parameters, request bodies, and stable response fields.

Choose the API or MCP

Compare deterministic server workflows with interactive AI-client work.