Contact us
Getting Started

API spec & tooling

Machine-readable artifacts generated from this documentation — an OpenAPI 3.1 spec and a Postman collection — plus how to import them.

These files are generated automatically from the same source as this site, so they always match the published reference. Endpoints held back with a draft flag are excluded.

OpenAPI 3.1 spec Import into Swagger UI, Insomnia, Postman, or generate a client SDK. /openapi.json → Postman collection Every endpoint as a ready-to-send request, grouped by area. Download .json →

Import into Postman

  1. In Postman, choose Import and select the downloaded yurbi-api.postman_collection.json (or paste the URL https://developers.yurbi.com/yurbi-api.postman_collection.json).
  2. Open the collection's Variables tab and set:
    • baseUrl — your Yurbi host, e.g. https://your-yurbi-server.com. On a default Windows install add the /yurbi prefix: https://your-yurbi-server.com/yurbi.
    • sessionToken — leave empty.
  3. Run Authentication → Log in (DoLogin) with your credentials. The collection captures the returned token into the sessionToken variable automatically, and every other request is ready to send.

Import into Insomnia / Swagger UI / code generators

Point any OpenAPI-aware tool at https://developers.yurbi.com/openapi.json. The server URL in the spec is a placeholder — replace it with your own Yurbi host. The same file works with openapi-generator and similar tools to scaffold a typed client.

For LLMs and answer engines

If you're feeding these docs to an AI assistant, the llms.txt index and the full llms-full.txt corpus are the most useful entry points — both are also generated from the published endpoints.