Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getopenrails.com/llms.txt

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

Open Rails is designed for agents to integrate without scraping the dashboard. Agents should use the capability endpoint, runtime schema endpoint, and the hosted skill.md file before mutating anything.

​
Install the skill

npx skills add https://docs.getopenrails.com
The skill tells agents what Open Rails can do, what endpoints to inspect, and what safety constraints matter.

​
Fetch capabilities

curl https://dash.getopenrails.com/api/agent/capabilities
This returns entrypoints, webhook events, schema routes, action descriptors, planned CLI commands, and MCP-compatible tool metadata.

​
Inspect schemas

curl https://dash.getopenrails.com/api/agent/schema/checkout.create
curl https://dash.getopenrails.com/api/agent/schema/fees.estimate
curl https://dash.getopenrails.com/api/agent/schema/webhook.example
Agents should generate payloads from these schemas instead of copying stale examples from a prompt.

​
Mutation rules

  • Prefer checkout.preview and fees.estimate before checkout.create.
  • Use environment: "sandbox" until the merchant has production provider credentials.
  • Always set an idempotencyKey for order-backed checkouts.
  • Pass redirectUrl per checkout session when the merchant needs dynamic return pages.
  • Treat production activation and provider credential connection as human-approved steps.

​
Recovery pattern

When an API call fails, parse the error.code, error.issues, and error.suggestion fields. Do not retry blindly. Fetch the schema for the failed operation, repair the payload, and retry once with the same idempotency key.