Skip to main content

Documentation Index

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

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

​
Build with AI assistants

Compass provides LLM-optimized documentation that AI coding assistants can fetch directly. These endpoints follow the llms.txt standard and are designed for AI consumption — concise, example-rich, and including all SDK field names and parameters.
Most AI coding assistants (Cursor, Claude Code, GitHub Copilot, ChatGPT) can automatically fetch and use these documentation URLs when you reference them in your project.

​
Documentation URLs

Point your AI assistant to these URLs:
URLDescriptionSize
docs.compasslabs.ai/llms-full.txtComplete documentation with all examples~60KB
docs.compasslabs.ai/llms.txtCondensed version for smaller context windows~17KB

​
Setup for AI coding assistants

Add to your project’s .cursor/rules or .cursorrules file:
When working with Compass API, fetch documentation from:
https://docs.compasslabs.ai/llms-full.txt

​
What’s included

The LLM documentation covers:
SectionDescription
SDK SetupInstallation for Python and TypeScript, environment configuration
Core ConceptsProduct Accounts, gas sponsorship, embedded fees
API EndpointsAll V2 endpoints with parameters and responses
SDK Field ReferenceExact field names for both Python and TypeScript SDKs
Code ExamplesComplete working examples for common workflows
TroubleshootingCommon errors and solutions

​
Example prompts

Once your AI assistant has access to the documentation, you can ask:
  • “Write a Python script to fetch the top 5 USDC vaults on Base by APY”
  • “How do I implement gas sponsorship for deposits?”
  • “Create a TypeScript function to check all my earn positions”
  • “What’s the difference between earn_transfer and earn_manage?”

CLI

Prefer to drive Compass from the command line? The CLI exposes every endpoint as a subcommand.

API Reference

Browse the complete API reference documentation.