staqlydocs
REST APIAPI reference

Overview

Look up any REST endpoint with its parameters, request body and response schema.

Edit on GitHub

This is the complete, endpoint-by-endpoint reference. Come here when you know what you want to do and need the exact path, fields or response shape. New to the API? Start with the REST API overview and its four-step walkthrough.

Find an endpoint

Pick the area

Endpoints are grouped by tag: posts, channels, schedules, webhooks and so on (see the cards below). Each area's page lists its operations.

Read the operation

Each operation has its own page with its parameters, request body, responses and generated code samples.

Add authentication

Every request sends Authorization: Bearer ...: in Staqly Community Edition the access token staqly prints at start (staqly serve token), in cloud mode an API key stk_...; the scope each operation needs is listed in Authentication & scopes.

Areas

Setup

Health, mode, signup, plans, MCP endpoint.

Auth

Session, workspace, usage, the access token, API keys, devices, recovery.

Accounts

Cloud sign-in (Google, email code, passkey), workspaces, members, roles and invitations.

Billing

Billing status and details, Stripe checkout and portal, X posts, add-ons, Stripe webhook.

Collections

Create, configure, archive, delete; a collection's posts.

Posts

Create, list, schedule, publish, cancel, duplicate, preview, numbers, preview links and feedback, per-channel results and retries, tags, requested work.

Channels

The provider catalog, developer apps, connecting and testing channels, OAuth, channel groups, connect links.

Schedules

Recurring and one-off schedules, run now.

Jobs

The background queue: list, stats, retry, cancel.

Media

Upload and download files, the library (folders, tags, Deleted, duplicates), the media editor's projects and AI.

Events

The activity log.

Webhooks

Endpoints, deliveries, retries, tests.

Alerts

Telegram, Slack, Discord, ntfy and email alerts and their deliveries.

System

Liveness, readiness, metrics.

Where it comes from

These pages are generated at build time from apps/api/openapi.yaml — the same OpenAPI 3.2 contract the dashboard and the SDKs are typed from. A running instance serves it at http://localhost:3333/openapi.yaml; this site has a copy at /openapi.yaml. Load it into your own tools (code generators, HTTP clients) to get the whole API at once.

Try a request

Every endpoint has a Send button that calls your cloud instance straight from your browser:

  1. In the server field, pick https://{host} and enter your instance's host name.
  2. Under authorization, paste an API key (stk_...) from Integrations → API keys. Use a key with only the scopes you want to try; it is kept in this browser.
  3. Fill in the parameters and press Send.

This works because cloud mode allows browser calls with an API key from this site (CORS_ALLOWED_ORIGINS, default https://docs.staqly.ai; see Configuration). It does not work against localhost: the Community Edition never answers browser calls from other websites. For your Community Edition install, use curl, the CLI or an SDK.

Event types

Look up every event staqly records, so you can read the activity log or subscribe a webhook or an alert to the right ones.

Setup

Instance status, signup and plans

On this page

Find an endpointPick the areaRead the operationAdd authenticationAreasWhere it comes fromTry a request