Developers
REST API
Base path /api/v1. Login or mint a token in Settings. Same domain as the calendar and MCP. Catalog lives at GET /api/v1/docs.
curl -X POST https://post.tianjiaji.cc/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email":"demo@postrelayer.local","password":"password"}'
| Method | Path | Ability | Summary |
|---|---|---|---|
| GET | /health | — | Liveness |
| GET | /status | — | PHP, DB, queue, OAuth/Stripe flags |
| GET | /mcp | — | MCP discovery and tool list |
| GET | /docs | — | This catalog |
| POST | /auth/register | — | Create user, workspace, and a * token (10/min/IP) |
| POST | /auth/login | — | Email/password → Bearer token (10/min/IP) |
| POST | /auth/google | — | Google OAuth; 503 until GOOGLE_CLIENT_ID is set |
| GET | /auth/providers | — | Password + P0 platform readiness and max_text |
| GET | /me | — | Current user and workspaces with role |
| POST | /auth/logout | — | Revoke the current Bearer token |
| GET | /tokens/scopes | — | Allowed token abilities |
| GET | /tokens | — | List personal access tokens |
| POST | /tokens | — | Mint a scoped API token |
| DELETE | /tokens/{tokenId} | — | Revoke a token |
| POST | /mcp | per-tool | JSON-RPC 2.0 tools/list and tools/call |
| GET | /billing | — | Plan, limits, usage |
| POST | /billing/checkout | — | Stripe Checkout; 503 until STRIPE_SECRET is set |
| GET | /workspaces | workspace:read | List workspaces |
| GET | /workspaces/{workspace} | workspace:read | Workspace detail |
| GET | /workspaces/{workspace}/members | workspace:read | Members and roles |
| GET | /workspaces/{workspace}/schedule | workspace:read | Weekly posting slots (does not change already scheduled posts) |
| GET | /workspaces/{workspace}/schedule/next | workspace:read | Next free posting slot in the workspace timezone |
| PUT | /workspaces/{workspace}/schedule | workspace:write | Replace weekly posting slots; already scheduled posts stay put |
| POST | /workspaces/{workspace}/invitations | workspace:write | Invite editor or viewer (owner only) |
| POST | /invitations/{token}/accept | — | Accept an invitation |
| GET | /workspaces/{workspace}/accounts | accounts:read | Connected social accounts (tokens hidden; includes max_text) |
| POST | /workspaces/{workspace}/accounts | accounts:write | Connect Fake (P0 OAuth waits for keys) |
| DELETE | /workspaces/{workspace}/accounts/{socialAccount} | accounts:write | Disconnect a social account |
| GET | /workspaces/{workspace}/folders | media:read | Media folders |
| POST | /workspaces/{workspace}/folders | media:write | Create a media folder |
| PATCH | /workspaces/{workspace}/folders/{folder} | media:write | Rename a media folder |
| DELETE | /workspaces/{workspace}/folders/{folder} | media:write | Delete a folder; assets become unfiled |
| GET | /workspaces/{workspace}/ai/models | workspace:read | Image generation models |
| POST | /workspaces/{workspace}/ai/image | workspace:write | Generate images; body prompt, model, ratio, count |
| GET | /workspaces/{workspace}/media | media:read | Media library; query folder_id, kind, source |
| POST | /workspaces/{workspace}/media | media:write | Upload from computer to local disk; duplicate bytes reuse the same URL |
| DELETE | /workspaces/{workspace}/media/{mediaAsset} | media:write | Delete a media asset |
| GET | /workspaces/{workspace}/posts | posts:read | List posts; query from, to, status, tag, q |
| GET | /workspaces/{workspace}/posts/export | posts:read | CSV export; same filters as list |
| GET | /workspaces/{workspace}/posts/{post} | posts:read | Post detail with targets and attempts |
| PATCH | /workspaces/{workspace}/posts/{post} | posts:write | Update draft/scheduled/failed post |
| DELETE | /workspaces/{workspace}/posts/{post} | posts:write | Delete draft/scheduled/failed post |
| POST | /workspaces/{workspace}/posts/preview | posts:read | Validate text against platform limits |
| GET | /workspaces/{workspace}/attempts | posts:read | Publish log; query status=published|failed|pending |
| POST | /workspaces/{workspace}/posts | posts:write | Create draft or scheduled post; optional repeatable, repeatable_times, repeatable_gap, repeatable_gap_unit |
| POST | /workspaces/{workspace}/posts/{post}/publish | posts:write | Publish now via adapters |
| POST | /workspaces/{workspace}/posts/{post}/duplicate | posts:write | Copy a post as a new draft |
| POST | /workspaces/{workspace}/posts/{post}/retry | posts:write | Retry failed targets |
| POST | /workspaces/{workspace}/posts/import | posts:write | CSV: text, scheduled_for, tags |
| GET | /workspaces/{workspace}/approvals | posts:read | Approval queue |
| POST | /workspaces/{workspace}/posts/{post}/approvals | posts:write | Submit a post for approval |
| POST | /workspaces/{workspace}/approvals/{approval}/review | posts:write | Approve or reject |