v1.0.0

OpenPost API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Accounts

Operations

GET/accountsPOST/accounts/bluesky/loginPOST/accounts/mastodon/exchangeGET/accounts/mastodon/serversDELETE/accounts/{account_id}PATCH/accounts/{account_id}GET/accounts/{platform}/auth-url

---

List connected social accounts for a workspace

GET

/accounts

Parameters

Query Parameters

workspace_id*

Filter by workspace ID

Type

string

Required

Responses

OK

Content-Type

application/json

[

]

GET

/accounts

Playground

Variables

Key

Value

workspace_id*

Samples

---

Connect Bluesky account using app password

POST

/accounts/bluesky/login

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/BlueskyLoginInputBody.json",

  

"app_password": "string",

  

"handle": "string",

  

"workspace_id": "string"

}

Responses

No Content

POST

/accounts/bluesky/login

Playground

Body

Samples

---

Exchange Mastodon OOB authorization code

POST

/accounts/mastodon/exchange

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/ExchangeCodeInputBody.json",

  

"code": "string",

  

"server_name": "string",

  

"workspace_id": "string"

}

Responses

No Content

POST

/accounts/mastodon/exchange

Playground

Body

Samples

---

List configured Mastodon servers

GET

/accounts/mastodon/servers

Responses

OK

Content-Type

application/json

[

]

GET

/accounts/mastodon/servers

Playground

Samples

---

Disconnect a social account

DELETE

/accounts/{account_id}

Parameters

Path Parameters

account_id*

Type

string

Required

Responses

No Content

DELETE

/accounts/{account_id}

Playground

Variables

Key

Value

account_id*

Samples

---

Update a social account

PATCH

/accounts/{account_id}

Parameters

Path Parameters

account_id*

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/UpdateAccountInputBody.json",

  

"slug": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/AccountResponse.json",

  

"account_id": "string",

  

"account_username": "string",

  

"id": "string",

  

"instance_url": "string",

  

"is_active": true,

  

"platform": "string",

  

"slug": "string",

  

"thread_replies_supported": true

}

PATCH

/accounts/{account_id}

Playground

Variables

Key

Value

account_id*

Body

Samples

---

Get OAuth authorization URL for a platform

GET

/accounts/{platform}/auth-url

Parameters

Path Parameters

platform*

Social platform (x, mastodon, bluesky, linkedin, threads)

Type

string

Required

Query Parameters

workspace_id*

Workspace ID to link account to

Type

string

Required

server_name

Mastodon server name from config (required for mastodon)

Type

string

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/GetAuthURLOutputBody.json",

  

"url": "string"

}

GET

/accounts/{platform}/auth-url

Playground

Variables

Key

Value

platform*

workspace_id*

server_name

Samples

---

Auth

Operations

GET/api-tokensPOST/api-tokensDELETE/api-tokens/{id}POST/auth/loginPOST/auth/login/passkey/optionsPOST/auth/login/passkey/verifyPOST/auth/login/totpGET/auth/mePOST/auth/registerGET/auth/securityPOST/auth/security/passkeys/beginPOST/auth/security/passkeys/finishPOST/auth/security/passkeys/{passkey_id}/removePOST/auth/security/totp/confirmPOST/auth/security/totp/disablePOST/auth/security/totp/setupPOST/cli/auth/approvePOST/cli/auth/denyPOST/cli/auth/pollGET/cli/auth/sessionPOST/cli/auth/start

---

List API tokens

GET

/api-tokens

Responses

OK

Content-Type

application/json

[

]

GET

/api-tokens

Playground

Samples

---

Create an API token

POST

/api-tokens

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/CreateAPITokenInputBody.json",

  

"expires_at": "string",

  

"name": "string",

  

"scope": "string"

}

Responses

Created

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/CreateAPITokenOutputBody.json",

  

"item": {

  

  

"created_at": "string",

  

  

"expires_at": "string",

  

  

"id": "string",

  

  

"last_used_at": "string",

  

  

"name": "string",

  

  

"revoked_at": "string",

  

  

"scope": "string",

  

  

"token_prefix": "string"

  

},

  

"token": "string"

}

POST

/api-tokens

Playground

Body

Samples

---

Revoke an API token

DELETE

/api-tokens/{id}

Parameters

Path Parameters

id*

API token ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/RevokeAPITokenOutputBody.json",

  

"revoked": true

}

DELETE

/api-tokens/{id}

Playground

Variables

Key

Value

id*

Samples

---

Login with email and password

POST

/auth/login

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/LoginInputBody.json",

  

"email": "string",

  

"password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/AuthOutputBody.json",

  

"mfa_methods": [

  

],

  

"mfa_token": "string",

  

"requires_mfa": true,

  

"token": "string",

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/login

Playground

Body

Samples

---

Begin MFA login with a passkey

POST

/auth/login/passkey/options

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/BeginPasskeyLoginInputBody.json",

  

"mfa_token": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PasskeyCeremonyOutputBody.json",

  

"challenge_id": "string",

  

"options": null

}

POST

/auth/login/passkey/options

Playground

Body

Samples

---

Complete MFA login with a passkey

POST

/auth/login/passkey/verify

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/FinishPasskeyLoginInputBody.json",

  

"challenge_id": "string",

  

"credential": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/AuthOutputBody.json",

  

"mfa_methods": [

  

],

  

"mfa_token": "string",

  

"requires_mfa": true,

  

"token": "string",

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/login/passkey/verify

Playground

Body

Samples

---

Complete MFA login with a TOTP code

POST

/auth/login/totp

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/VerifyTOTPLoginInputBody.json",

  

"code": "string",

  

"mfa_token": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/AuthOutputBody.json",

  

"mfa_methods": [

  

],

  

"mfa_token": "string",

  

"requires_mfa": true,

  

"token": "string",

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/login/totp

Playground

Body

Samples

---

Get current authenticated user

GET

/auth/me

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

"created_at": "string",

  

"email": "string",

  

"id": "string"

}

GET

/auth/me

Playground

Samples

---

Register a new user

POST

/auth/register

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/RegisterInputBody.json",

  

"email": "string",

  

"password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/AuthOutputBody.json",

  

"mfa_methods": [

  

],

  

"mfa_token": "string",

  

"requires_mfa": true,

  

"token": "string",

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/register

Playground

Body

Samples

---

Get account security settings

GET

/auth/security

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SecurityStatusOutputBody.json",

  

"methods": [

  

],

  

"passkeys": [

  

],

  

"totp_enabled": true,

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

GET

/auth/security

Playground

Samples

---

Begin passkey registration for the current user

POST

/auth/security/passkeys/begin

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/BeginPasskeyRegistrationInputBody.json",

  

"current_password": "string",

  

"name": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PasskeyCeremonyOutputBody.json",

  

"challenge_id": "string",

  

"options": null

}

POST

/auth/security/passkeys/begin

Playground

Body

Samples

---

Finish passkey registration for the current user

POST

/auth/security/passkeys/finish

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/FinishPasskeyRegistrationInputBody.json",

  

"challenge_id": "string",

  

"credential": "string",

  

"name": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SecurityStatusOutputBody.json",

  

"methods": [

  

],

  

"passkeys": [

  

],

  

"totp_enabled": true,

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/security/passkeys/finish

Playground

Body

Samples

---

Remove a passkey from the current user

POST

/auth/security/passkeys/{passkey_id}/remove

Parameters

Path Parameters

passkey_id*

Passkey ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/RemovePasskeyInputBody.json",

  

"current_password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SecurityStatusOutputBody.json",

  

"methods": [

  

],

  

"passkeys": [

  

],

  

"totp_enabled": true,

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/security/passkeys/{passkey_id}/remove

Playground

Variables

Key

Value

passkey_id*

Body

Samples

---

Confirm TOTP enrollment with a verification code

POST

/auth/security/totp/confirm

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/ConfirmTOTPSetupInputBody.json",

  

"challenge_id": "string",

  

"code": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SecurityStatusOutputBody.json",

  

"methods": [

  

],

  

"passkeys": [

  

],

  

"totp_enabled": true,

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/security/totp/confirm

Playground

Body

Samples

---

Disable TOTP for the current user

POST

/auth/security/totp/disable

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/DisableTOTPInputBody.json",

  

"current_password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SecurityStatusOutputBody.json",

  

"methods": [

  

],

  

"passkeys": [

  

],

  

"totp_enabled": true,

  

"user": {

  

  

"$schema": "https://example.com/schemas/UserProfile.json",

  

  

"created_at": "string",

  

  

"email": "string",

  

  

"id": "string"

  

}

}

POST

/auth/security/totp/disable

Playground

Body

Samples

---

Start TOTP enrollment for the current user

POST

/auth/security/totp/setup

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/SetupTOTPInputBody.json",

  

"current_password": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SetupTOTPOutputBody.json",

  

"challenge_id": "string",

  

"manual_entry_key": "string",

  

"otpauth_url": "string",

  

"qr_code_data_url": "string"

}

POST

/auth/security/totp/setup

Playground

Body

Samples

---

Approve CLI device authorization

POST

/cli/auth/approve

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/ApproveCLIAuthInputBody.json",

  

"device_code": "string",

  

"name": "string",

  

"scopes": "string",

  

"user_code": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/CLIAuthDecisionOutputBody.json",

  

"ok": true

}

POST

/cli/auth/approve

Playground

Body

Samples

---

Deny CLI device authorization

POST

/cli/auth/deny

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/DenyCLIAuthInputBody.json",

  

"device_code": "string",

  

"user_code": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/CLIAuthDecisionOutputBody.json",

  

"ok": true

}

POST

/cli/auth/deny

Playground

Body

Samples

---

Poll CLI device authorization

POST

/cli/auth/poll

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/PollCLIAuthInputBody.json",

  

"device_code": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PollCLIAuthOutputBody.json",

  

"expires_in": 0,

  

"interval": 0,

  

"retry_after": 0,

  

"status": "string",

  

"token": "string"

}

POST

/cli/auth/poll

Playground

Body

Samples

---

Get pending CLI authorization details

GET

/cli/auth/session

Parameters

Query Parameters

user_code

Type

string

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/GetCLIAuthSessionOutputBody.json",

  

"client_name": "string",

  

"client_os": "string",

  

"client_version": "string",

  

"expires_at": "string",

  

"requested_scopes": "string"

}

GET

/cli/auth/session

Playground

Variables

Key

Value

user_code

Samples

---

Start CLI device authorization

POST

/cli/auth/start

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/StartCLIAuthInputBody.json",

  

"client_name": "string",

  

"client_os": "string",

  

"client_version": "string",

  

"requested_scopes": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/StartCLIAuthOutputBody.json",

  

"device_code": "string",

  

"expires_in": 0,

  

"interval": 0,

  

"user_code": "string",

  

"verification_url": "string"

}

POST

/cli/auth/start

Playground

Body

Samples

---

System

Operations

GET/health

---

Health check

GET

/health

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/Health-checkResponse.json",

  

"status": "string"

}

GET

/health

Playground

Samples

---

Jobs

Operations

GET/jobs

---

List recent background jobs

GET

/jobs

Parameters

Query Parameters

limit

Number of jobs to return (default 50, max 200)

Type

integer

Format

"int64"

status

Filter by status (pending, processing, completed, failed)

Type

string

workspace_id

Filter by workspace ID

Type

string

Responses

OK

Content-Type

application/json

[

]

GET

/jobs

Playground

Variables

Key

Value

limit

status

workspace_id

Samples

---

Media

Operations

GET/mediaPOST/media/batch-deleteDELETE/media/{id}PATCH/media/{id}PATCH/media/{id}/favoriteGET/media/{id}/usage

---

List media attachments for a workspace

GET

/media

Parameters

Query Parameters

workspace_id*

Filter by workspace ID

Type

string

Required

filter

Filter: all, used, unused, favorites

Type

string

sort

Sort: newest, oldest, size

Type

string

limit

Limit (default 50, max 200)

Type

integer

Format

"int64"

offset

Offset for pagination

Type

integer

Format

"int64"

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/ListMediaOutputBody.json",

  

"media": [

  

],

  

"total": 0

}

GET

/media

Playground

Variables

Key

Value

workspace_id*

filter

sort

limit

offset

Samples

---

Delete multiple media attachments at once

POST

/media/batch-delete

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/BatchDeleteMediaInputBody.json",

  

"media_ids": [

  

]

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/BatchDeleteMediaOutputBody.json",

  

"deleted": 0,

  

"failed_ids": [

  

]

}

POST

/media/batch-delete

Playground

Body

Samples

---

Delete a media attachment (only if not used in any post)

DELETE

/media/{id}

Parameters

Path Parameters

id*

Media ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/DeleteMediaOutputBody.json",

  

"message": "string"

}

DELETE

/media/{id}

Playground

Variables

Key

Value

id*

Samples

---

Update media metadata (alt text)

PATCH

/media/{id}

Parameters

Path Parameters

id*

Media ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/UpdateMediaInputBody.json",

  

"alt_text": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/UpdateMediaOutputBody.json",

  

"message": "string"

}

PATCH

/media/{id}

Playground

Variables

Key

Value

id*

Body

Samples

---

Toggle favorite status of a media attachment

PATCH

/media/{id}/favorite

Parameters

Path Parameters

id*

Media ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/UpdateMediaFavoriteOutputBody.json",

  

"is_favorite": true

}

PATCH

/media/{id}/favorite

Playground

Variables

Key

Value

id*

Samples

---

Get posts that use a media attachment

GET

/media/{id}/usage

Parameters

Path Parameters

id*

Media ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/GetMediaUsageOutputBody.json",

  

"count": 0,

  

"usage": [

  

]

}

GET

/media/{id}/usage

Playground

Variables

Key

Value

id*

Samples

---

Posting Schedules

Operations

GET/posting-schedulesPOST/posting-schedulesGET/posting-schedules/next-slotPOST/posting-schedules/suggestDELETE/posting-schedules/{id}PATCH/posting-schedules/{id}

---

List posting schedules for a workspace

GET

/posting-schedules

Parameters

Query Parameters

workspace_id

Filter by workspace ID

Type

string

set_id

Filter by set ID (optional)

Type

string

Responses

OK

Content-Type

application/json

[

]

GET

/posting-schedules

Playground

Variables

Key

Value

workspace_id

set_id

Samples

---

Create a new posting schedule slot

POST

/posting-schedules

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/CreatePostingScheduleInputBody.json",

  

"day_of_week": 0,

  

"label": "string",

  

"local_day_of_week": 0,

  

"local_hour": 0,

  

"local_minute": 0,

  

"set_id": "string",

  

"utc_hour": 0,

  

"utc_minute": 0,

  

"workspace_id": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PostingScheduleResponse.json",

  

"created_at": "string",

  

"day_of_week": 0,

  

"id": "string",

  

"is_active": true,

  

"label": "string",

  

"local_day_of_week": 0,

  

"local_hour": 0,

  

"local_minute": 0,

  

"set_id": "string",

  

"utc_hour": 0,

  

"utc_minute": 0,

  

"workspace_id": "string"

}

POST

/posting-schedules

Playground

Body

Samples

---

Get the next available posting time slot

GET

/posting-schedules/next-slot

Parameters

Query Parameters

workspace_id

Workspace ID

Type

string

set_id

Optional set ID

Type

string

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/NextAvailableSlotOutputBody.json",

  

"message": "string",

  

"slot": {

  

  

"$schema": "https://example.com/schemas/PostingScheduleResponse.json",

  

  

"created_at": "string",

  

  

"day_of_week": 0,

  

  

"id": "string",

  

  

"is_active": true,

  

  

"label": "string",

  

  

"local_day_of_week": 0,

  

  

"local_hour": 0,

  

  

"local_minute": 0,

  

  

"set_id": "string",

  

  

"utc_hour": 0,

  

  

"utc_minute": 0,

  

  

"workspace_id": "string"

  

},

  

"slot_time": "string"

}

GET

/posting-schedules/next-slot

Playground

Variables

Key

Value

workspace_id

set_id

Samples

---

Generate a suggested posting schedule

POST

/posting-schedules/suggest

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/SuggestScheduleInputBody.json",

  

"posts_per_day": 0,

  

"workspace_id": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SuggestScheduleOutputBody.json",

  

"message": "string",

  

"schedules": [

  

]

}

POST

/posting-schedules/suggest

Playground

Body

Samples

---

Delete a posting schedule slot

DELETE

/posting-schedules/{id}

Parameters

Path Parameters

id*

Schedule ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/DeletePostingScheduleOutputBody.json",

  

"message": "string"

}

DELETE

/posting-schedules/{id}

Playground

Variables

Key

Value

id*

Samples

---

Update a posting schedule slot

PATCH

/posting-schedules/{id}

Parameters

Path Parameters

id*

Schedule ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/UpdatePostingScheduleInputBody.json",

  

"day_of_week": 0,

  

"is_active": true,

  

"label": "string",

  

"utc_hour": 0,

  

"utc_minute": 0

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PostingScheduleResponse.json",

  

"created_at": "string",

  

"day_of_week": 0,

  

"id": "string",

  

"is_active": true,

  

"label": "string",

  

"local_day_of_week": 0,

  

"local_hour": 0,

  

"local_minute": 0,

  

"set_id": "string",

  

"utc_hour": 0,

  

"utc_minute": 0,

  

"workspace_id": "string"

}

PATCH

/posting-schedules/{id}

Playground

Variables

Key

Value

id*

Body

Samples

---

Posts

Operations

GET/postsPOST/postsGET/posts/schedule-overviewPOST/posts/threadGET/posts/{id}DELETE/posts/{id}PATCH/posts/{id}GET/posts/{id}/variantsPUT/posts/{id}/variantsDELETE/posts/{id}/variants

---

List posts for a workspace

GET

/posts

Parameters

Query Parameters

workspace_id

Filter by workspace ID

Type

string

date

Filter by date (YYYY-MM-DD)

Type

string

status

Filter by status (draft, scheduled, published, failed)

Type

string

limit

Limit number of results (default 50, max 200)

Type

integer

Format

"int64"

Responses

OK

Content-Type

application/json

[

]

GET

/posts

Playground

Variables

Key

Value

workspace_id

date

status

limit

Samples

---

Create a new post

POST

/posts

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/CreatePostInputBody.json",

  

"content": "string",

  

"media_ids": [

  

],

  

"random_delay_minutes": 0,

  

"scheduled_at": "string",

  

"social_account_ids": [

  

],

  

"thread_draft": "string",

  

"workspace_id": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PostResponse.json",

  

"actual_run_at": "string",

  

"content": "string",

  

"created_at": "string",

  

"created_by": "string",

  

"destinations": [

  

],

  

"id": "string",

  

"media_ids": [

  

],

  

"random_delay_minutes": 0,

  

"scheduled_at": "string",

  

"status": "string",

  

"thread_draft": "string",

  

"workspace_id": "string"

}

POST

/posts

Playground

Body

Samples

---

Get monthly schedule overview

GET

/posts/schedule-overview

Parameters

Query Parameters

workspace_id

Filter by workspace ID

Type

string

platform

Filter by platform

Type

string

month

Month in YYYY-MM format (defaults to current month)

Type

string

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/ScheduleOverviewOutputBody.json",

  

"days": [

  

],

  

"month": 0,

  

"platforms": [

  

],

  

"selected_platform": "string",

  

"selected_workspace_id": "string",

  

"workspaces": [

  

],

  

"year": 0

}

GET

/posts/schedule-overview

Playground

Variables

Key

Value

workspace_id

platform

month

Samples

---

Create a thread of posts

POST

/posts/thread

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/CreateThreadInputBody.json",

  

"posts": [

  

],

  

"random_delay_minutes": 0,

  

"scheduled_at": "string",

  

"social_account_ids": [

  

],

  

"workspace_id": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/CreateThreadOutputBody.json",

  

"post_ids": [

  

]

}

POST

/posts/thread

Playground

Body

Samples

---

Get a single post

GET

/posts/{id}

Parameters

Path Parameters

id*

Post ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PostDetailResponse.json",

  

"actual_run_at": "string",

  

"content": "string",

  

"created_at": "string",

  

"created_by": "string",

  

"destinations": [

  

],

  

"id": "string",

  

"media": [

  

],

  

"random_delay_minutes": 0,

  

"scheduled_at": "string",

  

"status": "string",

  

"thread_draft": "string",

  

"workspace_id": "string"

}

GET

/posts/{id}

Playground

Variables

Key

Value

id*

Samples

---

Delete a post

DELETE

/posts/{id}

Parameters

Path Parameters

id*

Post ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/DeletePostOutputBody.json",

  

"message": "string"

}

DELETE

/posts/{id}

Playground

Variables

Key

Value

id*

Samples

---

Update a post

PATCH

/posts/{id}

Parameters

Path Parameters

id*

Post ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/UpdatePostInputBody.json",

  

"content": "string",

  

"media_ids": [

  

],

  

"random_delay_minutes": 0,

  

"scheduled_at": "string",

  

"social_account_ids": [

  

],

  

"thread_draft": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PostDetailResponse.json",

  

"actual_run_at": "string",

  

"content": "string",

  

"created_at": "string",

  

"created_by": "string",

  

"destinations": [

  

],

  

"id": "string",

  

"media": [

  

],

  

"random_delay_minutes": 0,

  

"scheduled_at": "string",

  

"status": "string",

  

"thread_draft": "string",

  

"workspace_id": "string"

}

PATCH

/posts/{id}

Playground

Variables

Key

Value

id*

Body

Samples

---

Get per-platform content variants for a post

GET

/posts/{id}/variants

Parameters

Path Parameters

id*

Post ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/GetVariantsOutputBody.json",

  

"variants": [

  

]

}

GET

/posts/{id}/variants

Playground

Variables

Key

Value

id*

Samples

---

Upsert per-platform content variants for a post

PUT

/posts/{id}/variants

Parameters

Path Parameters

id*

Post ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/UpsertVariantsInputBody.json",

  

"variants": [

  

]

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/UpsertVariantsOutputBody.json",

  

"variants": [

  

]

}

PUT

/posts/{id}/variants

Playground

Variables

Key

Value

id*

Body

Samples

---

Delete all variants for a post (reset to unified content)

DELETE

/posts/{id}/variants

Parameters

Path Parameters

id*

Post ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/DeleteVariantsOutputBody.json",

  

"message": "string"

}

DELETE

/posts/{id}/variants

Playground

Variables

Key

Value

id*

Samples

---

Prompts

Operations

GET/promptsPOST/promptsGET/prompts/categoriesGET/prompts/randomDELETE/prompts/{id}

---

List writing prompts

GET

/prompts

Parameters

Query Parameters

workspace_id

Filter by workspace ID

Type

string

category

Filter by category

Type

string

Responses

OK

Content-Type

application/json

[

]

GET

/prompts

Playground

Variables

Key

Value

workspace_id

category

Samples

---

Create a custom writing prompt

POST

/prompts

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/CreatePromptInputBody.json",

  

"category": "string",

  

"text": "string",

  

"workspace_id": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PromptResponse.json",

  

"category": "string",

  

"created_at": "string",

  

"id": "string",

  

"is_built_in": true,

  

"text": "string",

  

"user_id": "string",

  

"workspace_id": "string"

}

POST

/prompts

Playground

Body

Samples

---

Get available prompt categories

GET

/prompts/categories

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/GetPromptCategoriesOutputBody.json",

  

"categories": [

  

]

}

GET

/prompts/categories

Playground

Samples

---

Get a random writing prompt

GET

/prompts/random

Parameters

Query Parameters

workspace_id

Filter by workspace ID

Type

string

category

Filter by category

Type

string

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/PromptResponse.json",

  

"category": "string",

  

"created_at": "string",

  

"id": "string",

  

"is_built_in": true,

  

"text": "string",

  

"user_id": "string",

  

"workspace_id": "string"

}

GET

/prompts/random

Playground

Variables

Key

Value

workspace_id

category

Samples

---

Delete a custom prompt

DELETE

/prompts/{id}

Parameters

Path Parameters

id*

Prompt ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/DeletePromptOutputBody.json",

  

"message": "string"

}

DELETE

/prompts/{id}

Playground

Variables

Key

Value

id*

Samples

---

Sets

Operations

GET/setsPOST/setsGET/sets/{id}DELETE/sets/{id}PATCH/sets/{id}POST/sets/{id}/accountsDELETE/sets/{id}/accounts/{account_id}

---

List social media sets for a workspace

GET

/sets

Parameters

Query Parameters

workspace_id

Filter by workspace ID

Type

string

Responses

OK

Content-Type

application/json

[

]

GET

/sets

Playground

Variables

Key

Value

workspace_id

Samples

---

Create a social media set

POST

/sets

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/CreateSetInputBody.json",

  

"account_ids": [

  

],

  

"is_default": true,

  

"name": "string",

  

"workspace_id": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SetResponse.json",

  

"accounts": [

  

],

  

"created_at": "string",

  

"id": "string",

  

"is_default": true,

  

"name": "string",

  

"workspace_id": "string"

}

POST

/sets

Playground

Body

Samples

---

Get a single social media set

GET

/sets/{id}

Parameters

Path Parameters

id*

Set ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SetResponse.json",

  

"accounts": [

  

],

  

"created_at": "string",

  

"id": "string",

  

"is_default": true,

  

"name": "string",

  

"workspace_id": "string"

}

GET

/sets/{id}

Playground

Variables

Key

Value

id*

Samples

---

Delete a social media set

DELETE

/sets/{id}

Parameters

Path Parameters

id*

Set ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/DeleteSetOutputBody.json",

  

"message": "string"

}

DELETE

/sets/{id}

Playground

Variables

Key

Value

id*

Samples

---

Update a social media set

PATCH

/sets/{id}

Parameters

Path Parameters

id*

Set ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/UpdateSetInputBody.json",

  

"is_default": true,

  

"name": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SetResponse.json",

  

"accounts": [

  

],

  

"created_at": "string",

  

"id": "string",

  

"is_default": true,

  

"name": "string",

  

"workspace_id": "string"

}

PATCH

/sets/{id}

Playground

Variables

Key

Value

id*

Body

Samples

---

Add accounts to a social media set

POST

/sets/{id}/accounts

Parameters

Path Parameters

id*

Set ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/AddSetAccountsInputBody.json",

  

"account_ids": [

  

],

  

"is_main": true

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SetResponse.json",

  

"accounts": [

  

],

  

"created_at": "string",

  

"id": "string",

  

"is_default": true,

  

"name": "string",

  

"workspace_id": "string"

}

POST

/sets/{id}/accounts

Playground

Variables

Key

Value

id*

Body

Samples

---

Remove an account from a social media set

DELETE

/sets/{id}/accounts/{account_id}

Parameters

Path Parameters

id*

Set ID

Type

string

Required

account_id*

Account ID to remove

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/SetResponse.json",

  

"accounts": [

  

],

  

"created_at": "string",

  

"id": "string",

  

"is_default": true,

  

"name": "string",

  

"workspace_id": "string"

}

DELETE

/sets/{id}/accounts/{account_id}

Playground

Variables

Key

Value

id*

account_id*

Samples

---

Workspaces

Operations

GET/workspacesPOST/workspacesGET/workspaces/{id}/settingsPATCH/workspaces/{id}/settings

---

List workspaces for the current user

GET

/workspaces

Responses

OK

Content-Type

application/json

[

]

GET

/workspaces

Playground

Samples

---

Create a new workspace

POST

/workspaces

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/CreateWorkspaceInputBody.json",

  

"name": "string"

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/CreateWorkspaceOutputBody.json",

  

"created_at": "string",

  

"id": "string",

  

"name": "string"

}

POST

/workspaces

Playground

Body

Samples

---

Get workspace settings

GET

/workspaces/{id}/settings

Parameters

Path Parameters

id*

Workspace ID

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/GetWorkspaceSettingsOutputBody.json",

  

"draft_gap_minutes": 0,

  

"media_cleanup_days": 0,

  

"random_delay_minutes": 0,

  

"slot_end_hour": 0,

  

"slot_interval_minutes": 0,

  

"slot_start_hour": 0,

  

"timezone": "string",

  

"week_start": 0

}

GET

/workspaces/{id}/settings

Playground

Variables

Key

Value

id*

Samples

---

Update workspace settings

PATCH

/workspaces/{id}/settings

Parameters

Path Parameters

id*

Workspace ID

Type

string

Required

Request Body

application/json

{

  

"$schema": "https://example.com/schemas/UpdateWorkspaceSettingsInputBody.json",

  

"draft_gap_minutes": 0,

  

"media_cleanup_days": 0,

  

"random_delay_minutes": 0,

  

"slot_end_hour": 0,

  

"slot_interval_minutes": 0,

  

"slot_start_hour": 0,

  

"timezone": "string",

  

"week_start": 0

}

Responses

OK

Content-Type

application/json

{

  

"$schema": "https://example.com/schemas/UpdateWorkspaceSettingsOutputBody.json",

  

"draft_gap_minutes": 0,

  

"media_cleanup_days": 0,

  

"random_delay_minutes": 0,

  

"slot_end_hour": 0,

  

"slot_interval_minutes": 0,

  

"slot_start_hour": 0,

  

"timezone": "string",

  

"week_start": 0

}

PATCH

/workspaces/{id}/settings

Playground

Variables

Key

Value

id*

Body

Samples

---