Authentication
Create a named, expiring, tenant-bound credential in workspace settings. Send it as Authorization: Bearer …. The secret is displayed once and stored only as a hash.
Safety contract
- Select explicit read and write scopes; wildcard administrator keys are unavailable.
- Send
Idempotency-Keywith every mutation. - Use returned request IDs for support and reconciliation.
- Honor
X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset, andRetry-After. - Paginated list endpoints accept bounded page and page-size parameters where supported.
Resources
Identity, organizations, clients, properties, services, pricing quotes, bookings, jobs, scheduling, assignments, media metadata, delivery status, and operations issues are exposed only within the credential's tenant and scopes.
Private editing and marketing
Optional human-editing scopes support inspection, assignment to an existing private editor, and revision requests. Marketing scopes support private drafts, revisions, and export after human review. These scopes do not approve work, impersonate editors, publish media, or enable paid provider calls.
Error contract
{
"code": "permission_denied",
"message": "This credential requires the clients:write scope.",
"requestId": "…",
"retryable": false
}Outbound webhooks
Workspace administrators register an HTTPS endpoint and explicit event families. Deliveries include a unique event ID, Unix timestamp, and HMAC-SHA256 signature. Verify v1=HMAC(secret, timestamp.eventId.body), reject timestamps older than five minutes, and retain event IDs to reject replay.
MCP-compatible tools
GET /mcp/v1 publishes the bounded capability schema. POST /mcp/v1 accepts tools/call requests and inherits the API credential's exact tenant and scopes. It does not expose unrestricted autonomous execution.
Common integration flow
- Create the minimum API credential.
- Discover authority with
GET /api/v1/me. - Read or mutate only documented resources.
- Use one idempotency key per intended mutation.
- Subscribe to signed webhooks for asynchronous state.
Migration and portability
CSV imports are staged, validated, previewed, dry-run, explicitly approved, and provenance tracked. Replaying the same source does not create duplicates. Tenant exports contain customer-owned operational records; media binaries remain separately governed.
Generated clients
The OpenAPI 3.1 contract supports generated TypeScript or Python clients. Official SDKs are deferred until usage proves handwritten lifecycle helpers are necessary.
Deprecation
Breaking changes require a new path version. Deprecations are announced through the changelog and response metadata with at least 180 days' notice; security fixes may ship sooner when compatibility can be preserved.