OBAPI OBAPI

For AI Agents

OBAPI is designed to be implemented with the help of an AI coding assistant. The whole specification is exposed as machine-readable, single-URL entry points so you can hand an agent one link and let it do the work.

Entry points

URL What it is
https://obapi.org/llms.txt Curated map of the spec (markdown links), following the llmstxt.org convention. Best first read for an agent.
https://obapi.org/llms-full.txt Every documentation page concatenated into one file. One fetch, full context.
https://obapi.org/assets/openapi.yaml The OpenAPI 3 contract -- the machine-readable source of truth for endpoints and schemas.

Copy-paste prompt

Paste this into your AI coding agent (Claude Code, Cursor, etc.), adjusting the last line to your project:

Read the OBAPI specification at https://obapi.org/llms-full.txt (and the OpenAPI
contract at https://obapi.org/assets/openapi.yaml). OBAPI is an open standard REST
API for exchanging business documents (invoices, orders, proposals, and more).

Help me implement an OBAPI-compatible <client | provider> in my tool. Start by
summarising the objects and endpoints I need, propose an implementation plan, then
generate the code following the spec's conventions for authentication, discovery,
pagination and error handling.

Tips

  • Ask the agent to begin with the Discovery and Authentication pages: they define how a client negotiates capabilities and authenticates before touching any business object.
  • OBAPI groups objects in tiers (Core, Extended, Advanced). Tell the agent which tier you need so it does not over-implement.
  • The OpenAPI file is authoritative for exact field names and types; the markdown pages give the intent and workflows behind them.