# xAPI Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.xapi.to/_mcp/server

## Docs

- [xAPI 产品文档](https://docs.xapi.to/home/overview.md): AI Gateway 与 Sandbox 是两个独立产品域，共用账户与 API Key，但解决不同问题。
- [AI Gateway](https://docs.xapi.to/ai/overview.md): 统一协议、多上游路由、自动故障转移与透明 Token 计费。
- [快速开始](https://docs.xapi.to/ai/quickstart.md): 通过 curl 完成首次调用 —— ai.xapi.to 同时支持 Anthropic 与 OpenAI 协议。
- [模型与价格](https://docs.xapi.to/ai/models.md): xAPI 常用模型清单 —— 每个模型当前可拿到的最低价(USD / 1M tokens)。
- [设计原则](https://docs.xapi.to/ai/principles.md): 多源聚合、协议透明、透明计费、自动故障转移 —— xAPI 的核心架构选择。
- [Claude Code](https://docs.xapi.to/ai/integrations/claude-code.md): Anthropic 官方 CLI 接入 xAPI —— 通过环境变量切换 base URL,无需修改代码。
- [Codex](https://docs.xapi.to/ai/integrations/codex.md): OpenAI Codex CLI 接入 xAPI —— 两个环境变量,直连 SkyAPI 上游。
- [Cursor](https://docs.xapi.to/ai/integrations/cursor.md): 在 Cursor 中覆盖 OpenAI Base URL 与 API Key —— 一个密钥调用所有模型。
- [OpenClaw](https://docs.xapi.to/ai/integrations/openclaw.md): OpenClaw 自托管 AI 助手接入 xAPI —— 在 ~/.openclaw/openclaw.json 中注册一个自定义 provider。
- [Hermes Agent](https://docs.xapi.to/ai/integrations/hermes.md): Nous Research 出品的 Hermes Agent 接入 xAPI —— 通过 hermes config 命令配置自定义 endpoint。
- [Continue.dev](https://docs.xapi.to/ai/integrations/continue-dev.md): VS Code 与 JetBrains 插件 Continue 接入 xAPI —— 标准 OpenAI provider 配置。
- [Cline](https://docs.xapi.to/ai/integrations/cline.md): VS Code 插件 Cline 接入 xAPI —— OpenAI Compatible Provider,直接配置。
- [Windsurf](https://docs.xapi.to/ai/integrations/windsurf.md): Windsurf IDE 接入 xAPI —— 覆盖 OpenAI Base URL 与 API Key 即可。
- [Chatbox 等桌面客户端](https://docs.xapi.to/ai/integrations/chatbox.md): 桌面与 Web 聊天客户端接入 xAPI —— 标准 OpenAI provider 配置即可。
- [API 参考](https://docs.xapi.to/ai/api.md): 端点、鉴权、请求字段、响应头、错误码完整参考。
- [计费机制](https://docs.xapi.to/ai/billing.md): 按 Token 计费、预扣 → 结算两阶段、API Key 限额。
- [Sandbox 概览与核心概念](https://docs.xapi.to/sandbox/overview.md): 为 AI Agent 提供按能力选型、统一生命周期、按秒计费且完整可审计的隔离云环境。
- [Sandbox CLI 使用指南](https://docs.xapi.to/sandbox/cli.md): 使用 xapi-to 完成报价、创建、执行、文件、端口、生命周期、历史与审计。
- [REST API 调用流程](https://docs.xapi.to/sandbox/api-flow.md): 从报价到创建、执行、审计和销毁；默认使用生产 Gateway，每一步都能用 curl 或 API Explorer 验证。
- [全部 REST API 与测试](https://docs.xapi.to/sandbox/api.md): 17 个 Sandbox 接口集中在一个页面，默认使用 Production，也可切换 Test Gateway。
- [OpenAI Agents + xAPI Sandbox](https://docs.xapi.to/sandbox/openai-agents.md): 用 ai.xapi.to 的 DeepSeek 负责规划，用 xAPI Sandbox 负责真实、隔离、可审计的工具执行。
- [测试环境与 Console 日志](https://docs.xapi.to/sandbox/testing.md): 准确区分 test.xapi.to、sandbox.test.xapi.to 与 ai.xapi.to，并用服务端证据验收真实调用。
- [常见问题](https://docs.xapi.to/help/faq.md): 账户、密钥、计费、模型、集成排障 —— 最常见问题与处理方式。

## API Docs

- 逐接口 API Reference > Discovery [列出可用规格](https://docs.xapi.to/sandbox/api-reference/discovery/list-offerings.md)
- 逐接口 API Reference > Discovery [列出预置环境](https://docs.xapi.to/sandbox/api-reference/discovery/list-environments.md)
- 逐接口 API Reference > Discovery [获取报价](https://docs.xapi.to/sandbox/api-reference/discovery/create-quote.md)
- 逐接口 API Reference > Lifecycle [列出账户实例快照](https://docs.xapi.to/sandbox/api-reference/lifecycle/list-sandboxes.md)
- 逐接口 API Reference > Lifecycle [创建 Sandbox 实例](https://docs.xapi.to/sandbox/api-reference/lifecycle/create-sandbox.md)
- 逐接口 API Reference > Lifecycle [查询实例详情](https://docs.xapi.to/sandbox/api-reference/lifecycle/get-sandbox.md)
- 逐接口 API Reference > Lifecycle [暂停实例](https://docs.xapi.to/sandbox/api-reference/lifecycle/suspend-sandbox.md)
- 逐接口 API Reference > Lifecycle [恢复实例](https://docs.xapi.to/sandbox/api-reference/lifecycle/resume-sandbox.md)
- 逐接口 API Reference > Lifecycle [销毁实例](https://docs.xapi.to/sandbox/api-reference/lifecycle/terminate-sandbox.md)
- 逐接口 API Reference > Execution [执行 Shell 命令](https://docs.xapi.to/sandbox/api-reference/execution/execute-command.md)
- 逐接口 API Reference > Execution [读取文件](https://docs.xapi.to/sandbox/api-reference/execution/read-file.md)
- 逐接口 API Reference > Execution [写入文件](https://docs.xapi.to/sandbox/api-reference/execution/write-file.md)
- 逐接口 API Reference > Execution [列出文件](https://docs.xapi.to/sandbox/api-reference/execution/list-files.md)
- 逐接口 API Reference > Execution [获取端口访问地址](https://docs.xapi.to/sandbox/api-reference/execution/get-port-url.md)
- 逐接口 API Reference > Execution [调用供应商扩展](https://docs.xapi.to/sandbox/api-reference/execution/invoke-extension.md)
- 逐接口 API Reference > Audit [查询实例历史](https://docs.xapi.to/sandbox/api-reference/audit/list-sandbox-history.md)
- 逐接口 API Reference > Audit [查询审计流](https://docs.xapi.to/sandbox/api-reference/audit/get-sandbox-audit.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.xapi.to/openapi.json)
- [OpenAPI YAML](https://docs.xapi.to/openapi.yaml)