Search skmtc…
⌘K
Docs
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Generate
Filter operations
get
/api/platforms
List supported platforms
get
/api/plans
List plans and limits
post
/api/signup
Create an account (the API key is emailed as a confirmation link, not returned here)
get
/api/me
Account info, usage and connections
post
/api/connect
Connect a credential-based platform (telegram, bluesky, mastodon, discord, wordpress, devto, hashnode, slack, nostr)
post
/api/oauth/{platform}/url
Get an OAuth authorize URL for an OAuth platform (tiktok, youtube, linkedin, facebook, instagram)
post
/api/post
Post (or cross-post) to one or more platforms
get
/api/post/status
Check the status of a created post
post
/api/connect-link
Generate a hosted connect link for an end-user (multi-tenant)
post
/api/billing/checkout
Start a Stripe checkout for a paid plan
get
/api/keys
List your API keys (prefixes only — the secret is never returned)
post
/api/keys
Create a new API key, optionally with an expiry
delete
/api/keys/{id}
Revoke an API key immediately
get
/api/webhooks
List your webhook endpoints (the signing secret is never returned)
post
/api/webhooks
Add a webhook endpoint; the response carries its signing secret, once
delete
/api/webhooks/{id}
Delete a webhook endpoint (its pending deliveries are dropped)
post
/api/webhooks/{id}/test
Send a signed webhook.test event to this endpoint now and report what it answered
get
/api/webhooks/{id}/deliveries
The delivery log of an endpoint: the last 50 deliveries with status, attempts, the endpoint's answer and the payload
get
/api/bio
Read a brand's link-in-bio page, its views and each link's clicks
put
/api/bio
Create or update a brand's link-in-bio page
delete
/api/bio
Remove a brand's link-in-bio page
get
/api/status
Public service status: components, and delivery success per network over 30 days (no auth)
post
/api/media/upload-url
Get a signed URL to upload a photo or video (up to 1 GB). Files over 50 MB: send "multipart": true, PUT bytes [start, end) to each returned part's upload_url, then GET /api/media/finalize?path= returns one media_url for the whole file. Media passed by URL is fetched by us: up to 1GB for TikTok and YouTube (streamed), 80MB elsewhere.
get
/api/media/finalize
Confirm the upload landed and get the media_url to publish with
post
/api/generate
Write a native post per network, without publishing
get
/api/schedule
List queued posts
post
/api/schedule
Queue a post for a later time
get
/api/brands
List brands and the networks connected to each
post
/api/brands
Create a brand
get
/api/insights
What works: your best posts against your own median, and the patterns behind them
post
/api/insights/replicate
Draft new posts modelled on one of your best posts (nothing is published)
post
/api/insights/settings
Turn click tracking of your own links on or off
get
/api/coach
Coach: your results, your goal and your next move
post
/api/coach/goal
Coach: set your goal and weekly cadence
post
/api/coach/hook
Coach: score a post's first line for each network
post
/api/coach/share
Coach: a public image of your week in numbers
post
/api/connect/{platform}/move
Move a connected account to another brand of the same PostWire account
get
/api/trial
The no-card Pro trial: where it stands, what Pro did for this account, the offer
post
/api/trial/start
Start the no-card Pro trial now (an account that has published)
get
/api/account
Alias of GET /api/me: account info, usage and connections
get
/api/usage
This month's posts, today's AI drafts and brands, against the plan's limits
get
/api/plan
The account's plan, what it includes, current usage and the next plan with a checkout link
get
/api/billing
Plan, subscription state and where to manage billing
get
/api/connections
The connected accounts, with their brand and the identity each network reports
get
/api/brands/{id}
One brand and its connected accounts
delete
/api/brands/{id}
Delete a brand and disconnect its networks (an account keeps at least one brand)
patch
/api/brands/{id}
Rename a brand
get
/api/schedule/{id}
One scheduled post with each network's result
delete
/api/schedule/{id}
Cancel a queued or held post
patch
/api/schedule/{id}
Move or edit a queued post
post
/api/week
Write and queue a week of posts from one topic
delete
/api/connect/{platform}
Disconnect one network of one brand
get
/api/connect/{platform}/health
Check that a connection still works
post
/api/media/upload-link
A link to upload a file from another device (a phone), valid 24 hours
post
/api/media/video
Make a short vertical video from a post's words (for YouTube and TikTok)
post
/api/billing/portal
A Stripe customer-portal link to change plan, update the card or cancel
get
/api/tiktok/creator-info
The connected TikTok creator and what it may post with
get
/api/schedule/next-slot
Where run_at "next_slot" would put a post now (nothing is queued)
get
/api/brands/{id}/slots
A brand's queue slots: weekly times per network, and the timezone
put
/api/brands/{id}/slots
Set a brand's queue slots and timezone
get
/api/x
X (Twitter) credits: what posting to X uses and what this account has left
get
/api/x/quote
How many X credits one post (or a whole thread) would use, before it is published or scheduled
post
/api/x/credits/checkout
A Stripe Checkout link to buy X top-up credits (one-time payment)
get
/api/ai
AI drafts: about how many this month's AI budget holds and has left, AI credits and the packs
post
/api/ai/credits/checkout
A Stripe Checkout link to buy an AI credit pack (one-time payment)
get
/api/approvals
Approvals: posts waiting for a person, and the ones decided
get
/api/approvals/{id}
One approval, with its preview
post
/api/approvals/{id}/decision
Approve or reject a waiting post (dashboard session only)
post
/api/approvals/link
What an approval link shows (no API key: the link is the credential)
post
/api/approvals/link/decision
Approve or reject through an approval link
get
/api/approvals/settings
Each brand's approval rules, and what the plan includes
put
/api/brands/{id}/approvals
Set a brand's approval rules (dashboard session only)
get
/api/guardrails
Limits per API key and connected AI app, with this month's use
put
/api/guardrails/{kind}/{id}
Set the limits of one API key or connected AI app (dashboard session only)
get
/api/activity
The account's activity log
get
/api/activity.csv
The activity log as CSV (same filters, up to 5,000 rows)
get
/api/team
The team of this workspace: members, roles, open invitations, seats
patch
/api/team
Rename the workspace
post
/api/team/invites
Invite someone by email
post
/api/team/invites/{id}/resend
Send an invitation again (a new link; the old one stops working)
delete
/api/team/invites/{id}
Cancel an invitation
delete
/api/team/members/{id}
Remove a member
patch
/api/team/members/{id}
Change a member's role or brand list
post
/api/team/leave
Leave this workspace
post
/api/team/transfer
Transfer ownership to a member
get
/api/workspaces
The workspaces you belong to (the switcher)
post
/api/invites/view
What an invitation is (the /join/ page)
post
/api/invites/code
Email a 6-digit code to the invited address
post
/api/invites/verify
Join with the emailed code
post
/api/invites/accept
Join with the session you are signed in with
post
/api/bulk
Bulk upload: check, then schedule many posts at once (CSV or rows)
get
/api/bulk/template.csv
The bulk upload template
delete
/api/bulk/{id}
Undo a bulk upload
get
/api/recurring
List recurring posts
post
/api/recurring
Set up a recurring post
post
/api/recurring/preview
Preview a rule
get
/api/recurring/{id}
A recurring post
delete
/api/recurring/{id}
Delete a recurring post
patch
/api/recurring/{id}
Edit all occurrences, pause or resume
get
/api/rss
List feeds and sheets
post
/api/rss
Add a feed or a Google Sheet
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Generate code
List supported platforms
get
/api/platforms
Request
Base URL:
https://postwire.io
URL:
https://postwire.io/api/platforms
Auth:
none required
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.