API Reference

The OmniPost API is a REST API with JSON request and response bodies. All endpoints below are relative to the base URL and require the Authorization header described in Authentication.

Base URL

https://api.omnipost.dev/v1

Self-hosted deployments mount the same routes under {APP_URL}/api/v1.

Required headers

HeaderRequiredDescription
AuthorizationAlwaysBearer op_live_... or Bearer op_sandbox_....
Content-TypeOn requests with a bodyapplication/json.
Idempotency-KeyOptionalSafe-retry key for POST /v1/upload. See Errors.

Endpoints

MethodPathDescription
POST/v1/uploadCreate a post targeting one or more platforms.
GET/v1/postsList posts, paginated and filterable.
GET/v1/posts/:idFetch a single post and its per-platform targets.
GET/v1/accountsList connected social accounts.
POST/v1/accounts/:platform/connectGet a hosted OAuth connect URL.
DELETE/v1/accounts/:idDisconnect a social account.
POST/v1/webhooksRegister a webhook endpoint.

Conventions

Timestamps are ISO 8601 UTC (2026-08-02T14:03:11Z). IDs are opaque strings prefixed by resource type (post_, acct_, wh_) — treat them as opaque and don't parse their structure. Platform identifiers in request and response bodies are always the lowercase strings instagram, threads, tiktok, and x.

Explore the reference