OpenAPI and Swagger UI
OWOX Data Marts exposes OpenAPI specifications and Swagger UI for the HTTP API.
For OWOX Data Marts Cloud at https://app.owox.com, API documentation is available at:
- https://app.owox.com/api/openapi.json
- https://app.owox.com/api/openapi.yaml
- https://app.owox.com/api/swagger-ui
For a self-managed OWOX Data Marts instance at https://your-owox.example.com, use:
https://your-owox.example.com/api/openapi.jsonhttps://your-owox.example.com/api/openapi.yamlhttps://your-owox.example.com/api/swagger-ui
Use OpenAPI and Swagger UI to inspect available endpoints, request schemas, and response schemas.
Relationship to other API tools
Section titled âRelationship to other API toolsâ- Use owox-ctl when you want terminal commands.
- Use @owox/api-client when you build TypeScript or JavaScript integrations.
- Use OpenAPI and Swagger UI when you need to inspect or integrate with the raw HTTP API directly.
Authenticated API requests require API key-based authentication. Start with API Keys before calling protected endpoints.
Compatibility
Section titled âCompatibilityâThe same client and OWOX Data Marts server version is supported. Different versions are best effort.