# xQR Platform API

> Build with QR codes, short links, analytics, and link-in-bio pages using the xQR API.

## Docs

- [Quickstart](https://docs.xqr.co/getting-started/quickstart/): Make your first API call in 5 minutes
- [Authentication](https://docs.xqr.co/getting-started/authentication/): API key format, scopes, and security
- [Rate Limits](https://docs.xqr.co/getting-started/rate-limits/): Burst limits and monthly quotas per plan
- [Error Handling](https://docs.xqr.co/getting-started/error-handling/): Response envelope and error codes
- [Error Reference](https://docs.xqr.co/getting-started/error-reference/): Detailed guide for every error code
- [Versioning & Deprecation](https://docs.xqr.co/getting-started/versioning/): API stability guarantees

## API Reference

- [Overview](https://docs.xqr.co/api-reference/overview/): Base URL, auth, response format, pagination
- [Links](https://docs.xqr.co/api-reference/links/create-link/): Create, list, get, update, delete short links; bulk operations; QR generation
- [QR Codes](https://docs.xqr.co/api-reference/qr/create-template/): QR templates CRUD, generate and render QR images
- [Analytics](https://docs.xqr.co/api-reference/analytics/summary/): Summary, timeseries, geography, devices, top links, link stats
- [Link-in-Bio](https://docs.xqr.co/api-reference/bio/create-page/): Bio page CRUD, publish/unpublish, page stats
- [Assets](https://docs.xqr.co/api-reference/assets/presign-upload/): Presigned upload, confirm, publish to CDN, list, get, delete
- [Workspace](https://docs.xqr.co/api-reference/workspace/get-workspace/): Workspace info, usage, members
- [Webhooks](https://docs.xqr.co/api-reference/webhooks/create-webhook/): Webhook CRUD and delivery tracking

## Webhooks

- [Overview](https://docs.xqr.co/webhooks/overview/): Payload format, headers, event types
- [Signatures](https://docs.xqr.co/webhooks/signatures/): HMAC-SHA256 verification
- [Retries](https://docs.xqr.co/webhooks/retries/): Exponential backoff strategy
- [Events](https://docs.xqr.co/webhooks/events/): All event types and payload schemas

## MCP Server

- [Overview](https://docs.xqr.co/mcp/overview/): Connect AI agents via Model Context Protocol
- [Installation](https://docs.xqr.co/mcp/installation/): Setup for Claude Desktop, VS Code, Cursor
- [Tools](https://docs.xqr.co/mcp/tools/): 27 tools across 6 domains
- [Resources](https://docs.xqr.co/mcp/resources/): 7 browsable read-only resources

## SDKs

- [TypeScript](https://docs.xqr.co/sdks/typescript/): @xqr/sdk — type-safe Node.js client
- [Python](https://docs.xqr.co/sdks/python/): xqr-python — async-first Python client

## Guides

- [Create First Link](https://docs.xqr.co/guides/create-first-link/): Step-by-step link creation
- [QR Code Branding](https://docs.xqr.co/guides/qr-code-branding/): Templates, logos, design tips
- [Link-in-Bio Setup](https://docs.xqr.co/guides/link-in-bio-setup/): Bio page creation workflow
- [Webhook Integration](https://docs.xqr.co/guides/webhook-integration/): End-to-end webhook setup
- [Smart Routing](https://docs.xqr.co/guides/smart-routing/): Geo, device, time-based routing
- [Bulk Operations](https://docs.xqr.co/guides/bulk-operations/): Batch creation and updates
- [Using xQR with AI Agents](https://docs.xqr.co/guides/ai-agents/): MCP + Claude integration patterns
- [Analytics Interpretation](https://docs.xqr.co/guides/analytics-interpretation/): Understanding your analytics data

## Optional

- [OpenAPI Spec](https://docs.xqr.co/openapi.json): Machine-readable API specification
- [Full Docs](https://docs.xqr.co/llms-full.txt): Complete documentation for LLMs with large context windows