OpenAPI Schema

Learn more about documenting APIs in GitBook.

The Topaz Labs Platform API is documented using the OpenAPI 3.1 specification format.

Download

Download the complete OpenAPI schema to integrate with your tools and workflows:

Download Image API YAML

Download Video API YAML

Use Cases

The OpenAPI schema enables you to:

• Generate Client SDKs: Use tools like OpenAPI Generator to create client libraries in your preferred language

• API Testing: Import into testing tools like Postman or Insomnia

• Code Generation: Generate type definitions and API interfaces

• Documentation: Use with documentation generators and API explorers

• Validation: Validate API requests and responses against the schema

Integration Examples

Postman

1. Open Postman

2. Click Import

3. Select Link and paste the schema URL

4. Postman will generate a collection from the OpenAPI spec

Specification Details

• Version: OpenAPI 3.1.0

• Format: YAML

• Authentication: API Key (Admin keys required)

• Base URLs:

  • Image: https://api.topazlabs.com/image/v1

  • Video: https://api.topazlabs.com