Programmatic access to the Kompozy pipeline. The public API is in private beta; the schemas below are early drafts and may change.
Last verified · 2026-05-29 · by Moe Ameen
All requests must include an Authorization: Bearer <token>header. Tokens are issued from Settings → API Keys → Developer API (coming soon). Tokens scope to a single workspace.
https://api.kompozy.io/v1
Register a new ingestion source. The type field accepts one of 6 values: rss, scraper, youtube, tiktok, webhook, brand(Brand Prompt Lane — source-less generation from the persona profile and a topic pool).
Push raw content directly into the pipeline. Useful for webhook bridges.
List generated content items, filterable by source, status, and date range. The bucket filter accepts one of the 5 user-facing values: video, image, text, blog, newsletter. Internal engine outputs (Persona Short, Template Short, Clipped Short, Persona Tweet, Quote Graphic, etc.) all collapse into these 5 buckets for API consumers — read the engine_output field on each item if you need the underlying renderer identity.
Schedule or immediately publish a generated item to its configured platforms.
Aggregate performance metrics per outlet, content type, and date bucket.
Subscribe to events to receive POST callbacks when pipeline state changes. Configure endpoints in Settings → Webhooks.
raw.ingested — a new raw item entered the queue.generated.ready — an AI-generated variant is ready for review.published.success — an item was published successfully.published.failed — a publish attempt failed. Payload includes error detail.60 requests per minute per workspace, burst of 120. Exceeding returns HTTP 429.
Errors return standard HTTP status codes with a JSON body: { error: "...", detail?: [...] }. Unauthenticated requests return 401; exceeded quota returns 402; invalid inputs return 400.
Interested in the developer API? Email api@kompozy.iowith your use case and we'll whitelist your workspace.
Every request includes an Authorization: Bearer <token> header. Tokens are issued from Settings → API Keys → Developer API and scope to a single workspace. The base URL is https://api.kompozy.io/v1.
It is in private beta. The resource and webhook schemas are early drafts and may change. Email api@kompozy.io with your use case to have your workspace whitelisted.
60 requests per minute per workspace with a burst of 120. Exceeding the limit returns HTTP 429. Unauthenticated requests return 401 and exceeded quota returns 402.
Four pipeline events: raw.ingested (a new raw item entered the queue), generated.ready (an AI variant is ready for review), published.success, and published.failed (payload includes error detail). Configure endpoints in Settings → Webhooks.