> For the complete documentation index, see [llms.txt](https://help.blotato.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.blotato.com/rest-api-reference/api-reference.md). # Endpoint overview Find REST endpoint contracts for account lookup, publication, media, generation, sources, inbox, analytics, and credits. **Base URL:** `https://backend.blotato.com/v2` **Auth Header:** `blotato-api-key: YOUR_API_KEY` For a task-oriented entry point, read [Start with an AI agent](/start-with-an-ai-agent/agents.md). Use the [public operation index](/rest-api-reference/operations.md) for coverage of the live OpenAPI document, or the [agent reference](/start-with-an-ai-agent/llm.md) for compact request examples. Rate limits below describe selected routes. A dash means no limit is stated in this table, not unlimited access. Follow [Rate limits](/api-and-mcp-concepts/rate-limits.md). *** ## Account | Method | Endpoint | Description | Rate Limit | | ------ | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------- | | GET | [`/users/me`](/rest-api-reference/accounts/users.md) | Verify API key, get user info | — | | GET | [`/users/me/usage`](/rest-api-reference/accounts/users.md#get-usage) | Get connected-account usage, active-contact usage, and active-contact limit | — | | GET | [`/users/me/accounts`](/rest-api-reference/accounts.md) | List connected social accounts | — | | GET | [`/users/me/accounts/:id/subaccounts`](/rest-api-reference/accounts.md#list-subaccounts-pages) | Get Facebook/LinkedIn page IDs | — | | GET | [`/social/pinterest/boards`](/rest-api-reference/accounts.md#list-pinterest-boards) | List Pinterest boards (get boardId) | 45 / min | ## Credits | Method | Endpoint | Description | Rate Limit | | ------ | -------------------------------------------------------- | -------------------------------------------- | ---------- | | GET | [`/credits`](/rest-api-reference/credits.md) | Get credit balance and pricing | — | | POST | [`/credits`](/rest-api-reference/credits.md#buy-credits) | Create a Stripe Checkout link to buy credits | 10 / hour | ## Post | Method | Endpoint | Description | Rate Limit | | ------ | ------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ---------- | | POST | [`/posts`](/rest-api-reference/publish-post.md) | Create and publish a post | 30 / min | | GET | [`/posts`](/rest-api-reference/publish-post/list-posts.md) | List posts (scheduled, published, failed) | 60 / min | | GET | [`/posts/:postSubmissionId`](/rest-api-reference/publish-post/get-post.md) | Poll post publishing status | 60 / min | | GET | [`/published-posts`](/rest-api-reference/publish-post/list-published-posts.md) | List published posts with latest analytics | — | | GET | [`/published-posts/:id`](/rest-api-reference/publish-post/list-published-posts.md#get-a-published-post) | Get a published post and its original payload | — | | POST | [`/media`](/rest-api-reference/publish-post/upload-media-v2-media.md) | Upload media from URL (optional) | 30 / min | ## Analytics | Method | Endpoint | Description | Rate Limit | | ------ | --------------------------------------------------------------------------------------- | ----------------------------------- | ---------- | | GET | [`/analytics`](/rest-api-reference/analytics.md#list-top-performing-posts) | List top-performing posts | — | | GET | [`/analytics/platforms`](/rest-api-reference/analytics.md#list-performance-by-platform) | Compare platform performance | — | | GET | [`/analytics/summary`](/rest-api-reference/analytics.md#get-analytics-summary) | Get publishing and analytics totals | — | | GET | [`/posts/:id/analytics`](/rest-api-reference/analytics.md#get-post-analytics) | Get analytics for a published post | — | ## Comments | Method | Endpoint | Description | Rate Limit | | ------ | --------------------------------------------------------------------- | ---------------------------------- | ---------- | | GET | [`/comments`](/rest-api-reference/comments.md) | List comments on your posts | 60 / min | | GET | [`/comments/:commentId`](/rest-api-reference/comments.md#get-comment) | Get a single comment | 60 / min | | POST | [`/comments`](/rest-api-reference/comments.md#post-comment) | Post a comment on a published post | 30 / min | ## Messages | Method | Endpoint | Description | Rate Limit | | ------ | ------------------------------------------------------------------------------------ | --------------------------------- | ---------- | | GET | [`/conversations`](/rest-api-reference/messages.md) | List direct-message conversations | 60 / min | | GET | [`/conversations/:conversationId`](/rest-api-reference/messages.md#get-conversation) | Get a single conversation | 60 / min | | GET | [`/messages`](/rest-api-reference/messages.md#list-messages) | List messages | 60 / min | | GET | [`/messages/:messageId`](/rest-api-reference/messages.md#get-message) | Get a single message | 60 / min | | POST | [`/messages`](/rest-api-reference/messages.md#send-message) | Send a direct message | 30 / min | ## DM Automations | Method | Endpoint | Description | Rate Limit | | ------ | ------------------------------------------------------------------------------------------------------------------- | ----------------------- | ---------- | | GET | [`/dm-automations`](/rest-api-reference/dm-automations.md) | List DM automations | 60 / min | | GET | [`/dm-automations/:id`](/rest-api-reference/dm-automations.md#get-dm-automation) | Get a DM automation | 60 / min | | POST | [`/dm-automations`](/rest-api-reference/dm-automations.md#create-dm-automation) | Create a DM automation | 30 / min | | PATCH | [`/dm-automations/:id`](/rest-api-reference/dm-automations.md#update-dm-automation) | Update a DM automation | 30 / min | | PATCH | [`/dm-automations/:flowId/triggers/:triggerId`](/rest-api-reference/dm-automations.md#update-dm-automation-trigger) | Update a single trigger | 30 / min | | DELETE | [`/dm-automations/:id`](/rest-api-reference/dm-automations.md#delete-dm-automation) | Archive a DM automation | 30 / min | | GET | [`/dm-automations/:id/runs`](/rest-api-reference/dm-automations.md#list-runs) | List automation runs | 60 / min | | GET | [`/dm-automations/:id/logs`](/rest-api-reference/dm-automations.md#list-logs) | List automation logs | 60 / min | | GET | [`/dm-automations/:id/analytics`](/rest-api-reference/dm-automations.md#get-analytics) | Get automation stats | 60 / min | ## Scheduled Posts | Method | Endpoint | Description | Rate Limit | | ------ | -------------------------------------------------------------------------- | ----------------------- | ---------- | | GET | [`/schedules`](/rest-api-reference/schedules.md) | List scheduled posts | — | | GET | [`/schedules/:id`](/rest-api-reference/schedules.md#get-scheduled-post) | Get a scheduled post | — | | PATCH | [`/schedules/:id`](/rest-api-reference/schedules.md#update-scheduled-post) | Update a scheduled post | — | | DELETE | [`/schedules/:id`](/rest-api-reference/schedules.md#delete-scheduled-post) | Delete a scheduled post | — | ## Visual | Method | Endpoint | Description | Rate Limit | | ------ | ------------------------------------------------------------------------- | --------------------------- | ---------- | | POST | [`/videos/from-templates`](/rest-api-reference/create-video.md) | Create visual from template | 30 / min | | GET | [`/videos/creations/:id`](/rest-api-reference/create-video/find-video.md) | Poll visual creation status | — | | GET | [`/videos/templates`](/rest-api-reference/visuals.md) | List available templates | — | | DELETE | [`/videos/:id`](/rest-api-reference/create-video/delete-video.md) | Delete a video | — | ## Source | Method | Endpoint | Description | Rate Limit | | ------ | ------------------------------------------------------------------------------- | -------------------------------- | ---------- | | POST | [`/source-resolutions-v3`](/rest-api-reference/create-source.md) | Extract content from URL or text | 30 / min | | GET | [`/source-resolutions-v3/:id`](/rest-api-reference/create-source/get-source.md) | Poll source extraction status | 60 / min | *** ## Async Pattern Publishing, source extraction, visual generation, comment posting, and message sending use operation-specific completion checks. Uploads and configuration changes do not use this same polling pattern: 1. Submit a POST request to create the resource 2. Use the returned ID to poll the GET endpoint at the intervals in [Async jobs and polling](/api-and-mcp-concepts/async-jobs-and-polling.md) 3. Stop when the status reaches a terminal value See [Async Workflows](/api-and-mcp-concepts/workflows.md) for the full protocol and examples. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://help.blotato.com/rest-api-reference/api-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.