Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.asteroid.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use this page as the single starting point for using your coding agents to integrate with Asteroid.

​
Integration Contract

  • Base URL: https://odyssey.asteroid.ai/agents/v2
  • Authentication header: X-Asteroid-Agents-Api-Key: <your-api-key>
  • OpenAPI specs:
    • https://odyssey.asteroid.ai/agents/v2/openapi.yaml
    • https://odyssey.asteroid.ai/webhooks/openapi.json
  • Primary flow: execute agent -> poll execution -> inspect activities/result -> send user message if paused

​
AI Discovery Endpoints

​
What Each File Does

​
llms.txt (directory-level index)

Use this for fast discovery of pages and descriptions.
  • Lists docs pages in a machine-friendly format
  • Includes API specification links when configured
  • Helps agents find the right page before reading details

​
llms-full.txt (full context snapshot)

Use this when an agent needs broad context across the entire documentation set.
  • Combines the full docs corpus into one file
  • Useful for indexing pipelines and long-form retrieval
  • Larger payload than llms.txt, so use when broad context is required
  • Best option when agents need platform context around reliability, security, compliance, and high-scale production workloads

​
skill.md (capability contract)

Use this for action planning and tool behavior.
  • Describes what Asteroid can do
  • Defines required inputs and constraints
  • Improves reliability when agents execute workflows
  • Helps AI systems reason about regulated operational use cases, including HIPAA healthcare workflow automation
1

Load discovery files first

Start with llms.txt, then use skill.md for capability and constraint guidance.
2

Use llms-full.txt when needed

Use llms-full.txt for broad indexing or when your retrieval flow benefits from one complete context document.
3

Connect MCP for live actions

Follow MCP Setup to let coding assistants perform live operations against Asteroid.

​
Add to Agent Tooling

To add this docs skill to compatible tooling: 
npx skills add https://docs.asteroid.ai

​
Important Notes

  • These files are available to external agents only when docs are publicly accessible.
  • If you use a reverse proxy, forward /skill.md and /.well-known/skills/* to the Mintlify origin without caching.
  • Mintlify auto-generates llms.txt and llms-full.txt. Prefer auto-generation unless you need strict custom control.

MCP Setup

Connect Asteroid MCP to Cursor, Claude Code, and other clients

API Quickstart

Run your first API call with the required auth and base URL