# Documentation

The API documentation split into addressable pages - the language examples and the long guides, each complete on its own.

Every page below is complete on its own and can be read in any order. The whole reference, unsplit, is at https://mdapi.io/.

## Examples

- **JavaScript (fetch)** - The conversion called from JavaScript with `fetch` - GET answers Markdown, POST answers JSON with metadata.
  https://mdapi.io/docs/examples/javascript
- **Python** - The same conversion called from Python.
  https://mdapi.io/docs/examples/python
- **Go** - The same conversion called from Go.
  https://mdapi.io/docs/examples/go
- **Rust** - The same conversion called from Rust.
  https://mdapi.io/docs/examples/rust
- **OpenAI SDK** - The conversion called through the OpenAI-compatible client, streaming included.
  https://mdapi.io/docs/examples/openai
- **MCP Tool Examples** - The `convert` tool called over MCP: JSON-RPC requests with a prompt and a result format.
  https://mdapi.io/docs/examples/mcp

## Guides

- **Reading a document in parts** - Walking a large document part by part: the range a conversion reports, the headers carrying it, and `part=N`.
  https://mdapi.io/docs/parts
- **Searching a document without reading it** - Searching a converted document for literal substrings and getting addresses back instead of text.
  https://mdapi.io/docs/find
- **Documents larger than the input gate** - What the input ceiling applies to, and which formats stay readable when a document is larger than the gate.
  https://mdapi.io/docs/large-documents
- **Reading the embedded images** - The images a document carries - inline on GET, indexed in `attachments[]` on POST.
  https://mdapi.io/docs/images
- **Streaming Parameter** - Server-Sent Events delivery: the `stream` parameter, the frame shape and the termination markers.
  https://mdapi.io/docs/streaming
- **Response metadata** - The facts an answer carries in its headers: the service that replied, the document validators and the integrity field.
  https://mdapi.io/docs/response-metadata

## Links

- **About service:** https://mdapi.io/about
- **API documentation and conversion:** https://mdapi.io
- **MCP server manifest:** https://mdapi.io/mcp
- **Health check:** https://mdapi.io/health
- **Documentation index:** https://mdapi.io/llms.txt
- **Full API documentation:** https://mdapi.io/llms-full.txt
- **AI discovery:** https://mdapi.io/.well-known/ai-discovery.json or https://mdapi.io/ai-discovery.json
- **AI Agent discovery:** https://mdapi.io/.well-known/agent.json or https://mdapi.io/agent.json
- **A2A Agent card:** https://mdapi.io/.well-known/agent-card.json or https://mdapi.io/agent-card.json
- **ACP manifest:** https://mdapi.io/.well-known/acp.json or https://mdapi.io/acp.json
- **x402 payment manifest:** https://mdapi.io/.well-known/x402.json or https://mdapi.io/x402.json
- **OpenAPI specification (JSON):** https://mdapi.io/.well-known/openapi.json or https://mdapi.io/openapi.json
- **OpenAPI specification (YAML):** https://mdapi.io/.well-known/openapi.yaml or https://mdapi.io/openapi.yaml
- **MAPI specification:** https://mdapi.io/.well-known/mapi.md or https://mdapi.io/mapi.md
- **Skill specification:** https://mdapi.io/.well-known/skill.md or https://mdapi.io/skill.md
- **Agent Plugins manifest:** https://mdapi.io/.well-known/plugin/plugin.json or https://mdapi.io/.well-known/plugin.json
- **Agent Plugins MCP config:** https://mdapi.io/.well-known/plugin/mcp.json
- **Agent Plugins conversion skill:** https://mdapi.io/.well-known/plugin/skills/mdapi-conversion/SKILL.md
- **API documentation pages:** https://mdapi.io/docs

## External Links

- **github.com** https://github.com/mdapiio/mdapi.io
- **skills.sh** https://www.skills.sh/mdapiio/mdapi.io
- **skillsmp.com** https://skillsmp.com/creators/mdapiio/mdapi.io
- **clawhub.ai** https://clawhub.ai/mdapiio
- **x.com** https://x.com/mdapiio

## Disclaimer

**The service is provided "AS IS".**


> mdapi.io is an edge-native service-transport primitive for AI, autonomous-agents, and the Web4 ecosystem.