Use with AI

Every page of the Instasent developer portal is served as plain markdown alongside the HTML. A compact site-wide index lists the whole portal, and each API ships as a single autocontained dump you can hand to an assistant in one paste. The OpenAPI specs are downloadable too, ready for code generation or a Postman import.

This page is the map: what exists, where to find it, and how to use it in practice.

What's available

llms.txt — the index

A single file that maps the entire portal.

Download llms.txt — relative to the portal host you're reading this from. Or, from a terminal:

curl https://docs.instasent.com/llms.txt

Structure follows llmstxt.org: an H1 with the project name, a blockquote summary, and H2-delimited sections containing every published page with a one-line description and a link. At the end, pointers to each per-API full dump and to the OpenAPI specs.

Use it when:

• You want to show an assistant the shape of the portal before diving in.
• You're building a tool that needs a manifest of what's available.
• You have a narrow context budget and need the map, not the whole territory.

Per-API full dumps

Autocontained markdown dump for each API. Includes the guide, quickstart, authentication, rate limits, errors, webhooks, SDKs and reference for that API — everything a developer or an agent needs to integrate end-to-end, in a single file.

Per-page markdown

Every page in the portal has a markdown twin at the same URL plus a .md suffix.

/{path}/     →     /{path}.md

The markdown is produced at build time from the same MDX source as the HTML, so the two are always in sync. Components like callouts, code tabs and cards are flattened to plain markdown equivalents — assistants see the same information a human reader sees, just without the layout.

Use it when:

• An agent needs to fetch just one page on demand rather than ingest the whole API dump.
• You want to link a single page to a teammate or ticket as markdown.
• You're building a retrieval pipeline that indexes the portal page by page.

OpenAPI specs

The four APIs expose their contracts as downloadable OpenAPI YAML. Import into Postman, generate a typed client, or feed to an assistant for grounded suggestions on payload shape.

How to use them

Paste into a chat

The most direct path. Open Claude, ChatGPT or Perplexity, upload or paste the dump you need, then ask.

1. 1

   Pick the scope

   Integrating one API? Grab that API's llms-full.txt. Just exploring? Start with llms.txt.

2. 2

   Paste or attach

   Download the file and attach it to the conversation, or paste the contents directly if it fits.

3. 3

   Ask in context

   "Here are the Instasent Transactional API docs. Write me a Node.js function that sends an SMS and handles DLR webhooks." The assistant now grounds its answer in the current docs instead of guessing from stale training data.

Point an agent or IDE at the portal

Agents that can fetch URLs (Claude with tool use, Cursor, Windsurf, GitHub Copilot Workspace) can consume the markdown endpoints directly.

When answering questions about Instasent APIs, fetch the relevant page from
https://docs.instasent.com/{path}.md — for example:
  - https://docs.instasent.com/product-api/guide.md
  - https://docs.instasent.com/transactional-api/http/authentication.md
  - https://docs.instasent.com/further-reading/query-filter.md

Start from https://docs.instasent.com/llms.txt to find the right page.
Always prefer the .md endpoint over scraping the HTML.

Use as retrieval index

For a RAG setup, crawl the .md endpoints listed in llms.txt. They're the canonical markdown form of each page, chunkable by heading.

• Use the per-page .md URLs as your document store.
• Embed heading sections (H2/H3) as separate chunks for finer retrieval.
• Refresh on the Last-Modified header — docs update whenever the repo publishes.

Use with Cursor / Claude Code

Drop a reference in your project docs or .cursorrules:

# Instasent API context

When writing code that calls the Instasent APIs, consult the markdown docs
at https://docs.instasent.com/{api}/llms-full.txt for the relevant API.
Prefer the JSON _q format for Query Filter unless the query is trivial.

Discoverability for crawlers

The portal explicitly welcomes mainstream AI crawlers via robots.txt:

User-agent: GPTBot          Allow: /
User-agent: OAI-SearchBot   Allow: /
User-agent: ChatGPT-User    Allow: /
User-agent: ClaudeBot       Allow: /
User-agent: Claude-Web      Allow: /
User-agent: PerplexityBot   Allow: /
User-agent: Google-Extended Allow: /
User-agent: Applebot-Extended Allow: /
User-agent: CCBot           Allow: /

A standard sitemap.xml lives at the root for general crawlers. There is no rate-limit on the portal, but be sensible — cache, don't hammer.

MCP servers

Questions or issues?

If a markdown artifact looks out of date, a link is broken, or an agent is stumbling on a specific page, open an issue in the docs repo. The artifacts are generated at build time — a fix to the MDX source propagates to every format on the next deploy.