Skip to main content

API Reference

Blackbox serves its API reference directly from every running server instance.

Available Endpoints

URLDescription
/api/docsInteractive Scalar documentation UI
/api/openapi.yamlRaw OpenAPI 3.1 document

Suggested Use

Use the built-in API docs for:

  • Manual endpoint exploration
  • Client generation
  • Auth flow understanding
  • Operator integrations and scripting