Skip to content

openapi/openapi-llm-wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Openapi LLM Wiki

A structured, LLM-optimized knowledge base for the Openapi API marketplace. Drop the contents of knowledge/ into any LLM context to ground it with authoritative, up-to-date information about Openapi's company profile, platform architecture, API catalog, service endpoints, and frequently asked questions.

How to use

As LLM context (recommended)

This repository is designed to be consumed directly by an LLM agent or tool. Choose one of the following approaches, depending on your workflow:

  1. Chat-based LLMs (Claude, ChatGPT, Gemini, etc.) Copy and paste the entire contents of the knowledge/ folder into a new chat or project. This gives the model a comprehensive understanding of every Openapi service, endpoint, authentication model, billing mechanism, and platform convention.

  2. Agent frameworks (OpenAI Assistants, LangChain, LlamaIndex, etc.) Point your agent's vector store or file search tool at this repository. The markdown files in knowledge/ are already structured for retrieval: each service has a compact endpoint table and each OAS spec is available as raw JSON for tool-based API generation.

  3. MCP server / custom tool Clone this repo and expose it through an MCP resource or a custom file-read tool so the LLM can selectively load the files it needs at runtime.

  4. Openai-compatible providers with file upload Upload the entire knowledge/ tree as a project or knowledge base attachment.

Lightweight browsing

You can also browse the files manually to look up specific services, endpoints, or platform information without an LLM. Start with knowledge/README.md which acts as an index.

Service lookup pattern

When the LLM needs information about one specific service, load only the relevant files:

knowledge/oas/<service>.openapi.json       โ†’  the raw OpenAPI 3 specification
knowledge/services/<service>.md            โ†’  human-readable endpoint summary

Always pair with knowledge/platform-guide.md for cross-cutting concerns (auth, billing, async patterns) and knowledge/faq.md for troubleshooting.

Repository structure

openapi-llm-wiki/
โ”œโ”€โ”€ knowledge/
โ”‚   โ”œโ”€โ”€ README.md                 โ† index of the knowledge base
โ”‚   โ”œโ”€โ”€ company-profile.md        โ† who Openapi is, history, certifications, data sources
โ”‚   โ”œโ”€โ”€ services-catalog.md       โ† catalog of all 28 APIs with base URLs and categories
โ”‚   โ”œโ”€โ”€ platform-guide.md         โ† authentication, scopes, billing, sandbox, async patterns
โ”‚   โ”œโ”€โ”€ faq.md                    โ† console FAQ (account, API usage, payments)
โ”‚   โ”œโ”€โ”€ references.md             โ† official websites, GitHub repos, SDKs, Postman, status page
โ”‚   โ”œโ”€โ”€ services/                 โ† per-service endpoint references (generated from OAS specs)
โ”‚   โ”‚   โ”œโ”€โ”€ company.md
โ”‚   โ”‚   โ”œโ”€โ”€ risk.md
โ”‚   โ”‚   โ”œโ”€โ”€ smsv2.md
โ”‚   โ”‚   โ””โ”€โ”€ ... (28 service files)
โ”‚   โ””โ”€โ”€ oas/                      โ† snapshot of official OpenAPI 3 specifications
โ”‚       โ”œโ”€โ”€ 00-list.txt           โ† canonical URLs for all specs
โ”‚       โ”œโ”€โ”€ company.openapi.json
โ”‚       โ”œโ”€โ”€ risk.openapi.json
โ”‚       โ””โ”€โ”€ ... (29 OAS files)
โ”œโ”€โ”€ LICENSE
โ””โ”€โ”€ README.md                     โ† this file

What the LLM can answer

With this knowledge base loaded, the LLM can accurately answer questions such as:

  • "How do I authenticate to the Openapi platform?"
  • "What is the base URL for the Company API and what endpoints does it expose?"
  • "Which service should I use for Italian digital signatures?"
  • "How does the async request pattern work for document retrieval?"
  • "What are the differences between wallet-based and subscription billing?"
  • "How do I create a token via the OAuth v2 API?"
  • "Is the old OAuth v1 still supported?"
  • "What data sources does Openapi rely on for company information?"
  • "Generate me the curl command for looking up a German company."

Keeping it up to date

The canonical source of truth for OpenAPI specifications is:

https://console.openapi.com/oas/en/<service>.openapi.json

The full list of spec URLs is in knowledge/oas/00-list.txt.

To refresh this knowledge base:

  1. Re-download each spec from its canonical URL into knowledge/oas/.
  2. Regenerate the endpoint summaries in knowledge/services/ from the updated specs.
  3. Review knowledge/services-catalog.md and knowledge/platform-guide.md for any platform-level changes.

The API Library in the Openapi console is the authoritative source for which APIs are active, deprecated, or newly introduced.

License

MIT โ€” see LICENSE.

About

๐Ÿ“š LLM Wiki โ€” A structured knowledge repository designed for LLMs and AI agents, containing authoritative documentation for the @openapiยฎ API marketplace.

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Contributors