> 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.md).

# REST API reference

- [Endpoint overview](https://help.blotato.com/rest-api-reference/api-reference.md): Find REST endpoint contracts for account lookup, publication, media, generation, sources, inbox, analytics, and credits.
- [Public operation index](https://help.blotato.com/rest-api-reference/operations.md): Match a REST method and path to its request, response, and error reference.
- [Account](https://help.blotato.com/rest-api-reference/accounts.md): Retrieve connected social account IDs and subaccounts before selecting a publishing destination.
- [User Info](https://help.blotato.com/rest-api-reference/accounts/users.md): Verify the authenticated Blotato user, subscription information, and account usage through REST.
- [Voice IDs](https://help.blotato.com/rest-api-reference/accounts/voice-ids.md): Choose the exact voice name accepted by your visual template. Voice IDs below describe the underlying ElevenLabs voices, not a universal Create Visual field.
- [Credits](https://help.blotato.com/rest-api-reference/credits.md): Read the authenticated account's credit balance and purchase limits, or create a checkout link without completing payment.
- [Post](https://help.blotato.com/rest-api-reference/publish-post.md): Build a REST publish request with platform-specific targets, media, scheduling fields, and a submission ID for verification.
- [Get Post Status](https://help.blotato.com/rest-api-reference/publish-post/get-post.md): Look up a submission ID to distinguish processing, scheduled, published, and failed results without repeating a write.
- [List Posts](https://help.blotato.com/rest-api-reference/publish-post/list-posts.md): Find scheduled, published, or failed posts using date, platform, status, and pagination filters.
- [List Published Posts](https://help.blotato.com/rest-api-reference/publish-post/list-published-posts.md): Retrieve published post records and distinguish published-post IDs from submission and schedule IDs.
- [Upload Media](https://help.blotato.com/rest-api-reference/publish-post/upload-media-v2-media.md): Choose direct public media URLs or a presigned upload, transfer local bytes, and distinguish upload from conversion.
- [Media Requirements](https://help.blotato.com/rest-api-reference/publish-post/media.md)
- [Analytics](https://help.blotato.com/rest-api-reference/analytics.md)
- [Metrics Reference](https://help.blotato.com/rest-api-reference/analytics/analytics-metrics.md)
- [Comments](https://help.blotato.com/rest-api-reference/comments.md): Read Instagram or Facebook comments, send an authorized comment or reply, and inspect queued or failed results.
- [Messages](https://help.blotato.com/rest-api-reference/messages.md): Read Instagram or Facebook conversations and send permitted private replies using existing recipient IDs.
- [DM Automations API](https://help.blotato.com/rest-api-reference/dm-automations.md): Configure Instagram or Facebook trigger-based DMs, activation, gates, runs, logs, and automation analytics.
- [Visual](https://help.blotato.com/rest-api-reference/create-video.md): Create a visual from a template using validated inputs or a prompt, then retain the creation ID for status lookup.
- [Get Visual Status](https://help.blotato.com/rest-api-reference/create-video/find-video.md): Check visual generation status and errors, then retrieve finished image or video URLs.
- [Delete Video](https://help.blotato.com/rest-api-reference/create-video/delete-video.md): Delete a generated visual through REST only when the user requests removal of the identified item.
- [Visual Templates](https://help.blotato.com/rest-api-reference/visuals.md)
- [Product Scene Placement](https://help.blotato.com/rest-api-reference/visuals/f524614b-ba01-448c-967a-ce518c52a700.md)
- [Image Slideshow with Text Overlays](https://help.blotato.com/rest-api-reference/visuals/5903b592-1255-43b4-b9ac-f8ed7cbf6a5f.md)
- [Instagram Carousel Slideshow](https://help.blotato.com/rest-api-reference/visuals/53cfec04-2500-41cf-8cc1-ba670d2c341a.md)
- [Quote Card with Monocolor Background](https://help.blotato.com/rest-api-reference/visuals/77f65d2b-48cc-4adb-bfbb-5bc86f8c01bd.md)
- [Quote Card with Paper Background and Highlight](https://help.blotato.com/rest-api-reference/visuals/f941e306-76f7-45da-b3d9-7463af630e91.md)
- [Tweet Card with Minimal Style](https://help.blotato.com/rest-api-reference/visuals/ba413be6-a840-4e60-8fd6-0066d3b427df.md)
- [Tweet Card with Photo/Video Background](https://help.blotato.com/rest-api-reference/visuals/9714ae5c-7e6b-4878-be4a-4b1ba5d0cd66.md)
- [Tutorial Carousel with Minimalist Flat Style](https://help.blotato.com/rest-api-reference/visuals/2491f97b-1b47-4efa-8b96-8c651fa7b3d5.md)
- [Tutorial Carousel with Monocolor Background](https://help.blotato.com/rest-api-reference/visuals/e095104b-e6c5-4a81-a89d-b0df3d7c5baf.md)
- [Image Slideshow with Prominent Text](https://help.blotato.com/rest-api-reference/visuals/0ddb8655-c3da-43da-9f7d-be1915ca7818.md)
- [When X then Y Text Slideshow](https://help.blotato.com/rest-api-reference/visuals/c9892c3b-fa75-4ade-821a-a50ff8456230.md)
- [Video of Images and Text with Minimal Style](https://help.blotato.com/rest-api-reference/visuals/3ed4bb92-dbfe-45e6-9dc8-605b77f70506.md)
- [Combine Clips and Apply Basic Edits](https://help.blotato.com/rest-api-reference/visuals/c306ae43-1dcc-4f45-ac2b-88e75430ffd8.md)
- [AI Video with AI Voice](https://help.blotato.com/rest-api-reference/visuals/5903fe43-514d-40ee-a060-0d6628c5f8fd.md)
- [AI Selfie Talking Video with Consistent Character](https://help.blotato.com/rest-api-reference/visuals/57f5a565-fd17-458b-be43-4a2d8ccaca75.md)
- [AI Avatar with AI Generated B-roll](https://help.blotato.com/rest-api-reference/visuals/7c26a1cd-d5b3-42da-9c73-2413333873b3.md)
- [TV Wall Infographic](https://help.blotato.com/rest-api-reference/visuals/013904bf-6b3b-43f4-bb1f-f1964a38c29b.md)
- [Newspaper Infographic](https://help.blotato.com/rest-api-reference/visuals/07a5b5c5-387c-49e3-86b1-de822cd2dfc7.md)
- [Breaking News](https://help.blotato.com/rest-api-reference/visuals/8800be71-52df-4ac7-ac94-df9d8a494d0f.md)
- [Movie Theater Infographic](https://help.blotato.com/rest-api-reference/visuals/b88c8273-6406-48c6-85e7-096119aefe30.md)
- [Graffiti Mural Infographic](https://help.blotato.com/rest-api-reference/visuals/3598483b-c148-4276-a800-eede85c1c62f.md)
- [Bus Ad Infographic](https://help.blotato.com/rest-api-reference/visuals/f9c0e470-9288-4958-8cdd-64772ed93c05.md)
- [Billboard Infographic](https://help.blotato.com/rest-api-reference/visuals/76b3b959-bdbe-440d-8428-984219353f18.md)
- [Classroom Chalkboard Infographic](https://help.blotato.com/rest-api-reference/visuals/d9495026-3945-44f6-8b44-07c28c492e6d.md)
- [Whiteboard Infographic](https://help.blotato.com/rest-api-reference/visuals/ae868019-820d-434c-8fe1-74c9da99129a.md)
- [Chalkboard Infographic](https://help.blotato.com/rest-api-reference/visuals/fcd64907-b103-46f8-9f75-51b9d1a522f5.md)
- [Trail Marker Infographic](https://help.blotato.com/rest-api-reference/visuals/29ebb2bd-02b7-4317-8bb8-c30eb938e47c.md)
- [Constellation Infographic](https://help.blotato.com/rest-api-reference/visuals/5307053e-046b-4c9b-b1ca-38725d2ddcdd.md)
- [Manga Panel Infographic](https://help.blotato.com/rest-api-reference/visuals/49c61370-a706-4b82-98f7-62d557d1c66d.md)
- [T-Shirt Infographic](https://help.blotato.com/rest-api-reference/visuals/476f8920-8749-4ff7-9c91-470d54c3c03e.md)
- [Futuristic Flyer](https://help.blotato.com/rest-api-reference/visuals/8fa8545e-8955-4a89-a868-cf45023d6cc5.md)
- [Book Page Infographic](https://help.blotato.com/rest-api-reference/visuals/f8f1ebe4-a9f5-4ec8-be63-21214656cd4b.md)
- [Single Centered Text Quote](https://help.blotato.com/rest-api-reference/visuals/9f4e66cd-b784-4c02-b2ce-e6d0765fd4c0.md)
- [Steampunk Infographic](https://help.blotato.com/rest-api-reference/visuals/7b7104f1-d277-4993-ad3a-e5883c4b776d.md)
- [Top Secret Infographic](https://help.blotato.com/rest-api-reference/visuals/b8707b58-a106-44af-bb12-e30507e561af.md)
- [Egyptian Hieroglyph Infographic](https://help.blotato.com/rest-api-reference/visuals/a7b0d128-8478-4b34-9647-a0778b6517d0.md)
- [Cave Painting Infographic](https://help.blotato.com/rest-api-reference/visuals/82ee75b6-597b-43a8-86bc-e4395e7c9c44.md)
- [Schedule](https://help.blotato.com/rest-api-reference/schedules.md): List, inspect, update, or cancel an existing scheduled post using its schedule ID.
- [Weekly posting schedule](https://help.blotato.com/rest-api-reference/schedule-slots.md): Configure destination-specific calendar slots through REST for next-free-slot scheduling.
- [Source](https://help.blotato.com/rest-api-reference/create-source.md): Submit a typed URL or text source for extraction and retain its ID for completion checks.
- [Get Source](https://help.blotato.com/rest-api-reference/create-source/get-source.md): Retrieve extracted text and source status by ID, including failure messages and client-side transcript cleaning.
- [OpenAPI Reference](https://help.blotato.com/rest-api-reference/openapi-reference.md)
- [Publishing](https://help.blotato.com/rest-api-reference/openapi-reference/publishing.md)
- [Accounts](https://help.blotato.com/rest-api-reference/openapi-reference/accounts.md)
- [Billing](https://help.blotato.com/rest-api-reference/openapi-reference/billing.md)
- [Video](https://help.blotato.com/rest-api-reference/openapi-reference/video.md)
- [Analytics](https://help.blotato.com/rest-api-reference/openapi-reference/analytics.md)
- [Messaging](https://help.blotato.com/rest-api-reference/openapi-reference/messaging.md)
- [Comments](https://help.blotato.com/rest-api-reference/openapi-reference/comments.md)
- [Automations](https://help.blotato.com/rest-api-reference/openapi-reference/automations.md)


---

# 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.md?ask=<question>&goal=<user_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.