Documentation Index
Fetch the complete documentation index at: https://docs.getmaito.com/llms.txt
Use this file to discover all available pages before exploring further.
REST Endpoints
This reference tracks the public REST surface exposed through the SDK, CLI, and developer-facing API. Authenticated routes require a bearer token unless marked public.Billing
Plan status and hosted billing session creation.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/billing/status | Get the current user’s billing access. |
POST | /v1/billing/checkout-session | Create a checkout redirect session. |
POST | /v1/billing/change-plan | Change billing plan. |
POST | /v1/billing/portal-session | Create a customer portal redirect session. |
API Keys
API key creation and revocation.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/api-keys | List API keys. |
POST | /v1/api-keys | Create an API key. |
DELETE | /v1/api-keys/:apiKeyId | Revoke an API key. |
Account Sets
Create, select, update, archive, and configure publishing account sets.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/account-sets | List account sets. |
POST | /v1/account-sets | Create an account set. |
PUT | /v1/account-sets/:accountSetId | Update an account set. |
DELETE | /v1/account-sets/:accountSetId | Archive an account set. |
POST | /v1/account-sets/active | Set the active account set. |
GET | /v1/account-sets/:accountSetId/accounts | List accounts in an account set. |
POST | /v1/account-sets/:accountSetId/default-account | Set the default publishing account. |
GET | /v1/account-sets/:accountSetId/profile-context | Get profile context. |
PUT | /v1/account-sets/:accountSetId/profile-context | Update profile context. |
Drafts
Create, revise, archive, schedule, publish, unschedule, and inspect draft chats.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/drafts | List drafts. |
POST | /v1/drafts | Create a draft. |
GET | /v1/drafts/:draftId | Get a draft with versions. |
DELETE | /v1/drafts/:draftId | Archive a draft. |
POST | /v1/drafts/:draftId/revise | Create a new draft version. |
POST | /v1/drafts/:draftId/schedule | Schedule a draft. |
POST | /v1/drafts/:draftId/publish | Publish a draft now. |
POST | /v1/drafts/:draftId/unschedule | Remove a scheduled publish. |
GET | /v1/drafts/:draftId/chat | Get draft chat state. |
Documents
Document-first storage for notes, profiles, style references, ideas, proofs, and posts.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/documents | List documents. |
POST | /v1/documents/search | Search documents. |
GET | /v1/documents/by-path | Get a document by path. |
PUT | /v1/documents/by-path | Create or update a document by path. |
POST | /v1/documents/context | Build ranked document context. |
POST | /v1/documents | Create a document. |
GET | /v1/documents/:documentId | Get a document by ID. |
PATCH | /v1/documents/:documentId | Update a document by ID. |
Social
Social destinations, provider discovery, OAuth handoff, and token-based connection.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/social/destinations | List connected destinations. |
GET | /v1/social/providers | List available providers. |
POST | /v1/social/connect/begin | Begin a provider OAuth flow. |
POST | /v1/social/connect/complete | Complete a provider OAuth flow. |
POST | /v1/social/connect/token | Connect with a provider token. |
POST | /v1/social/x-media/connect/begin | Begin X media OAuth. |
POST | /v1/social/x-media/connect/complete | Complete X media OAuth. |
DELETE | /v1/social/destinations/:connectionId | Disconnect a social destination. |
Calendar
Publishing calendar time-slot settings.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/calendar/time-slots | Get publishing time slots. |
PUT | /v1/calendar/time-slots | Update publishing time slots. |
Queue
Scheduled publish queue items and attempts.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/queue-items | List queued publish items. |
POST | /v1/queue-items/:queueItemId/retry | Retry a queued item. |
DELETE | /v1/queue-items/:queueItemId | Delete a queued item. |
GET | /v1/queue-items/:queueItemId/attempts | List publish attempts for a queue item. |
Newsletter
Newsletter settings, domains, subscribers, segments, tags, custom fields, issues, sends, referrals, analytics, and operational status.| Method | Endpoint | Purpose |
|---|---|---|
GET | /v1/newsletter/settings | Get newsletter settings. |
PUT | /v1/newsletter/settings | Update newsletter settings. |
GET | /v1/newsletter/admin/operations-dashboard | Get newsletter operations status. |
POST | /v1/newsletter/social-embed-preview | Preview a newsletter social embed. |
POST | /v1/newsletter/sender-verification | Request sender verification. |
POST | /v1/newsletter/sender-verification/check | Check sender verification. |
GET | /v1/newsletter/domains | List newsletter domains. |
PUT | /v1/newsletter/domains/web | Set the web domain. |
PUT | /v1/newsletter/domains/redirect | Set the redirect domain. |
POST | /v1/newsletter/domains/:domainId/check | Check domain status. |
DELETE | /v1/newsletter/domains/:domainId | Delete a domain. |
GET | /v1/newsletter/email-provider-settings | Get email provider settings. |
PUT | /v1/newsletter/email-provider-settings | Update email provider settings. |
GET | /v1/newsletter/subscribers | List subscribers. |
POST | /v1/newsletter/subscribers/import | Import subscribers. |
POST | /v1/newsletter/subscribers/:subscriberId/block | Block a subscriber. |
DELETE | /v1/newsletter/subscribers/:subscriberId | Delete a subscriber. |
GET | /v1/newsletter/segments | List segments. |
POST | /v1/newsletter/segments | Create a segment. |
POST | /v1/newsletter/segments/preview | Preview segment rules. |
GET | /v1/newsletter/segments/:segmentId | Get a segment. |
PUT | /v1/newsletter/segments/:segmentId | Update a segment. |
DELETE | /v1/newsletter/segments/:segmentId | Delete a segment. |
POST | /v1/newsletter/segments/:segmentId/preview | Preview a saved segment. |
GET | /v1/newsletter/segments/:segmentId/subscribers | List segment subscribers. |
GET | /v1/newsletter/segments/:segmentId/subscribers/:subscriberId/explain | Explain why a subscriber matched a segment. |
GET | /v1/newsletter/subscriber-tags | List subscriber tags. |
POST | /v1/newsletter/subscriber-tags | Create a subscriber tag. |
DELETE | /v1/newsletter/subscriber-tags/:tagId | Delete a subscriber tag. |
PUT | /v1/newsletter/subscribers/:subscriberId/tags | Update subscriber tags. |
GET | /v1/newsletter/subscriber-fields | List custom fields. |
POST | /v1/newsletter/subscriber-fields | Create a custom field. |
DELETE | /v1/newsletter/subscriber-fields/:fieldId | Delete a custom field. |
PUT | /v1/newsletter/subscribers/:subscriberId/fields | Update subscriber custom fields. |
GET | /v1/newsletter/categories | List issue categories. |
POST | /v1/newsletter/categories | Create an issue category. |
DELETE | /v1/newsletter/categories/:categoryId | Delete an issue category. |
GET | /v1/newsletter/content-snippets | List content snippets. |
POST | /v1/newsletter/content-snippets | Create a content snippet. |
DELETE | /v1/newsletter/content-snippets/:snippetId | Delete a content snippet. |
GET | /v1/newsletter/issues | List newsletter issues. |
POST | /v1/newsletter/issues | Create an issue. |
GET | /v1/newsletter/issues/:issueId | Get an issue. |
PUT | /v1/newsletter/issues/:issueId | Update an issue. |
DELETE | /v1/newsletter/issues/:issueId | Delete an issue. |
POST | /v1/newsletter/issues/:issueId/send-test | Send a test issue email. |
POST | /v1/newsletter/issues/:issueId/audience-preview | Preview an issue audience. |
POST | /v1/newsletter/issues/:issueId/send | Send an issue now or schedule it with scheduledFor. |
GET | /v1/newsletter/referrals | List referrals. |
GET | /v1/newsletter/referrals/summary | Get referral summary. |
GET | /v1/newsletter/referrals/leaderboard | Get referral leaderboard. |
GET | /v1/newsletter/referrals/profile/:subscriberId | Get referral profile. |
POST | /v1/newsletter/referrals/:referralId/reject | Reject a referral. |
POST | /v1/newsletter/referrals/:referralId/void | Void a referral. |
GET | /v1/newsletter/analytics | Get overview analytics. |
GET | /v1/newsletter/issues/:issueId/analytics | Get issue analytics. |
GET | /v1/newsletter/issues/:issueId/link-analytics | Get issue link analytics. |
GET | /v1/newsletter/analytics/sources | Get subscriber source analytics. |
GET | /v1/newsletter/analytics/attribution | Get attribution analytics. |
Public Newsletter
Public subscribe, settings, referral visit, and unsubscribe endpoints.| Method | Endpoint | Purpose |
|---|---|---|
POST | /v1/public/newsletter/subscribe | Subscribe to a public newsletter. |
GET | /v1/public/newsletter/settings | Get public newsletter settings. |
POST | /v1/public/newsletter/referral-visit | Record a public referral visit. |
POST | /v1/public/newsletter/unsubscribe | Unsubscribe with a token. |
GET | /v1/public/newsletter/unsubscribe | Unsubscribe link endpoint. |
Tools
Utility endpoints used by free tools and product workflows.| Method | Endpoint | Purpose |
|---|---|---|
POST | /v1/tools/linkedin-video/resolve | Resolve a LinkedIn video URL. |
POST | /v1/tools/linkedin-headline-generator | Generate LinkedIn headline options. |
POST | /v1/tools/personal-brand-statement | Generate personal brand statement options. |
Extension
Browser extension capture and swipe-file document workflows.| Method | Endpoint | Purpose |
|---|---|---|
POST | /v1/extension/capture | Ingest an extension capture payload. |
GET | /v1/extension/swipe-file/items | List imported swipe-file items. |
POST | /v1/extension/swipe-file/items | Save an imported swipe-file item. |
PATCH | /v1/extension/swipe-file/items | Update an imported swipe-file item. |
DELETE | /v1/extension/swipe-file/items | Archive an imported swipe-file item. |
GET | /v1/extension/swipe-file/collections | List swipe-file collections. |
POST | /v1/extension/swipe-file/collections | Deprecated; returns 410. |
Supporting Routes
Authenticated supporting routes exposed by the SDK, CLI, or app workflows.| Method | Endpoint | Purpose |
|---|---|---|
POST | /v1/chat/suggestions | Get chat suggestions. |
POST | /v1/chat | Stream chat response. |
POST | /v1/feature-requests | Create a feature request. |
POST | /v1/media/upload | Upload media. |
POST | /v1/posts/blog | Create or update a blog post. |
GET | /v1/onboarding/status | Get onboarding status. |
POST | /v1/onboarding/complete | Complete onboarding. |
GET | /v1/onboarding/publication-suggestion | Get a publication suggestion. |
GET | /v1/onboarding/voice-step | Get onboarding voice state. |
PUT | /v1/onboarding/voice-step | Save onboarding voice state. |