Documentation

HTTP routes an account can call

Generated from the route files on every build: 634 routes in 55 namespaces — method, scope, 402, receipt header, access and the tool that calls each route. Pick a namespace, or type to filter the list.

Generated by node scripts/api-catalog.cjs from app/api/**/route.ts; do not edit by hand. 634 routes admit an account caller (an acc_ key or an account sign-in); 40 can answer 402; 32 carry the usage receipt header; 288 are named by an account-visible MCP tool. Auth headers, scopes, the 402 bodies and the receipt are explained in api-for-accounts.md; prices in self-serve-billing-api.md.

Columns:

  • Methods: the HTTP methods the route file exports.
  • Scope: the scopes a key can hold that the route file names. A key needs the one the method it calls demands; a miss is 403 SCOPE_DENIED. none means the file names no scope: any active key of the account may call it.
  • 402: the route checks money before it works and can refuse with a 402 body.
  • Receipt: a 2xx answer carries X-Linkio-Usage-Receipt for a key that holds billing:read.
  • Access: key = an acc_ key or an account sign-in; self-serve key = a managed account's key gets 403 ACCOUNT_TYPE_DENIED; session only = the route admits an account sign-in but no key reaches it; session only (scope) = the route demands a scope no self-serve key can hold, so a key gets 403 SCOPE_DENIED.
  • Tools: the MCP tools whose request path is this route. This column is route-level: a tool often calls the /api/internal/... twin of a /api/clients/... route, so a route with no tool is not by itself a gap. The tool catalog (mcp-tools-for-accounts.md) is the parity source.
NamespaceRoutesPage
/api/account106account
/api/accounts5accounts
/api/admin1admin
/api/agent-reports4agent-reports
/api/ai-find-sites6ai-find-sites
/api/analysis13analysis
/api/asset-bank5asset-bank
/api/backlinks4backlinks
/api/billing3billing
/api/bulk-analysis2bulk-analysis
/api/clients92clients
/api/configuration1configuration
/api/credits2credits
/api/exchange-approval-batches1exchange-approval-batches
/api/exchanges7exchanges
/api/google1google
/api/internal/accounts1internal-accounts
/api/internal/ai-find-sites5internal-ai-find-sites
/api/internal/article-gen9internal-article-gen
/api/internal/backlink-cases1internal-backlink-cases
/api/internal/bulk-analysis2internal-bulk-analysis
/api/internal/change-requests1internal-change-requests
/api/internal/client-config3internal-client-config
/api/internal/clients38internal-clients
/api/internal/collaborative-placements2internal-collaborative-placements
/api/internal/dataforseo1internal-dataforseo
/api/internal/line-items9internal-line-items
/api/internal/opportunity-intel3internal-opportunity-intel
/api/internal/orders9internal-orders
/api/internal/outreach-agent1internal-outreach-agent
/api/internal/replacement-status1internal-replacement-status
/api/internal/search-queries6internal-search-queries
/api/internal/site-approvals1internal-site-approvals
/api/internal/target-pages5internal-target-pages
/api/internal/topic-gen11internal-topic-gen
/api/internal/websites2internal-websites
/api/internal/whitelabel-report-docs1internal-whitelabel-report-docs
/api/internal/workflows14internal-workflows
/api/line-items11line-items
/api/llm-pricing1llm-pricing
/api/notifications1notifications
/api/opportunities21opportunities
/api/opportunity-intel8opportunity-intel
/api/order-line-items4order-line-items
/api/orders53orders
/api/projects1projects
/api/prospectfinder77prospectfinder
/api/publisher1publisher
/api/publisher-offerings1publisher-offerings
/api/subscriptions8subscriptions
/api/target-pages25target-pages
/api/target-urls1target-urls
/api/vetted-sites7vetted-sites
/api/websites7websites
/api/workflows28workflows

This page as markdown: /docs/api/routes.md. All pages for agents: /llms.txt.