# OpenAPI Schema

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:

{% columns %}
{% column width="50%" %} <a href="https://openapi.gitbook.com/o/HctdcUHRfIWXBVA1egPp/spec/image-12-25-updated.yaml" class="button primary" data-icon="arrow-up-right-from-square">Download Image API YAML</a>
{% endcolumn %}

{% column width="50%" %} <a href="https://openapi.gitbook.com/o/HctdcUHRfIWXBVA1egPp/spec/video-12-25-updated.yaml" class="button primary" data-icon="arrow-up-right-from-square">Download Video API YAML</a>
{% endcolumn %}
{% endcolumns %}

### 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`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.topazlabs.com/reference/openapi-specs/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.