OpenAPI Documentation

Bailo provides an OpenAPI specification for all Bailo endpoints viewable here on a running Bailo instance.

The screenshot above shows the Swagger UI interface with grouped API endpoints, request parameters, and response schemas.

Using Swagger UI

Swagger UI lets you browse, understand, and test API (Application Programming Interface) endpoints directly in your browser.

Browsing endpoints

Endpoints are grouped by category (Models, Releases, Files, Schemas, etc.). Click on a group to expand it and see all available endpoints. Each endpoint shows:

The HTTP method and path
A description of what it does
Required and optional parameters
Request body schema (for POST/PUT/PATCH)
Response schema and status codes

Making test requests

You can test endpoints directly from the Swagger UI:

Click on an endpoint to expand it
Click Try it out
Fill in the required parameters and request body
Click Execute
View the response below

Note: You must be authenticated to make requests. If you're logged into Bailo in the same browser, your session credentials will be used automatically.

Downloading the OpenAPI specification

Download the raw OpenAPI specification in JSON format for use with code generation tools or API clients.

Navigate to /api/v2/specification on your Bailo instance
The response is the full OpenAPI JSON specification

You can use this specification with tools like:

OpenAPI Generator to generate client libraries
Postman to import all endpoints as a collection
Insomnia for API testing

Endpoint summary

For a complete list of all API endpoints, see the interactive Swagger API.

For guidance on Swagger UI itself, see the official Swagger documentation.