Build with AI

Everything on this page helps an AI coding assistant work against the Partner API: an MCP server that searches these docs, machine-readable exports of every page, and a prompt to bootstrap an integration.

The docs MCP server

An unauthenticated server that gives AI tools search and retrieval over this documentation, so your assistant answers from the current spec instead of guessing:

https://developers.getswipe.in/mcp

Connecting

Claude
Claude Code
Cursor

In claude.ai or the Claude desktop app: Settings → Connectors → Add custom connector, then paste the server URL.

claude mcp add --transport http swipe-docs https://developers.getswipe.in/mcp

Add to ~/.cursor/mcp.json (or .cursor/mcp.json in your project):

{
  "mcpServers": {
    "swipe-docs": {
      "url": "https://developers.getswipe.in/mcp"
    }
  }
}

You can also use the contextual menu on any page of these docs — the copy and open options next to each page title send the current page to ChatGPT, Claude, Cursor, or VS Code directly.

This server serves documentation only. It has no access to any Swipe account and needs no API key. Your API key belongs in your own backend, never in an AI client — see Authentication.

Machine-readable documentation

Resource	URL
Docs index for AI tools	`/llms.txt`
Entire docs as one file	`/llms-full.txt`
Any page as Markdown	append `.md` to its URL, e.g. `/quickstart.md`
OpenAPI 3.0.1 spec	`/api-reference/openapi.json`

Bootstrap prompt

Starting an integration with an AI coding assistant? Paste this in first:

You are helping me integrate the Swipe Partner API (Indian GST invoicing).

- Base URL: https://app.getswipe.in/api/partner
- Auth: Authorization: Bearer <API_KEY> (keys are company-scoped; I'm using a test company)
- Rate limit: 1 request/second — make calls sequentially
- All dates are DD-MM-YYYY
- Full API spec: https://developers.getswipe.in/api-reference/openapi.json
- Docs index: https://developers.getswipe.in/llms.txt
- Responses use the envelope {success, message, error_code, errors, data};
  handle failures by error_code, not message text
- Documents (invoices etc.) are addressed by the hash_id returned at creation

Start by creating a minimal invoice (POST /v2/doc with document_type,
document_date, party, items), then fetch its PDF
(GET /v2/doc/pdf/{hash_id}) to verify the flow works.

Get Started

Guides

Resources

Documents

Payments

E-Way Bills

Customers

Vendors

Products

Inventory

Subscriptions

Utility

Build with AI

The docs MCP server

Connecting

Machine-readable documentation

Bootstrap prompt

​The docs MCP server

​Connecting

​Machine-readable documentation

​Bootstrap prompt

The docs MCP server

Connecting

Machine-readable documentation

Bootstrap prompt