Skip to main content

OpenAPI documents

Add an OpenAPI specification to give your assistant API documentation. Biel.ai reads endpoint descriptions, parameters and schemas from the specification.

Tip

Specification links are omitted from assistant citations. To restrict who can query the content, use project access control.

Requirements​

  • Valid OpenAPI/Swagger syntax (versions 2.0, 3.0.x, 3.1.x).
  • JSON (.json) or YAML (.yaml, .yml) format.
  • A public URL, or access through saved Web login credentials.

Add an OpenAPI document​

  1. In the Biel.ai dashboard, select your project.

  2. Go to Settings > Sources > OpenAPI.

  3. Enter the document URL.

    The OpenAPI tab of the Sources settings page

  4. To add another specification, click Add OpenAPI URL and enter its URL.

  5. Click Save.

  6. Click Refresh sources to index the specifications. Check the loading status and Logs in the project dashboard.

Example URLs:

https://api.example.com/openapi.json
https://docs.example.com/swagger.yaml
https://api.example.com/v1/openapi.yml

For a source behind a login, open its Advanced options and choose Credentials (optional) before saving. See Private content to set up Web login credentials.

Troubleshooting​

Document not loading​

  • Check the URL is public, or verify the selected credentials’ access.
  • Verify valid OpenAPI syntax.

Validation errors​

  • Check logs for validation details.
  • Fix syntax errors and click Refresh sources.