> For the complete documentation index, see [llms.txt](https://developer.topazlabs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.topazlabs.com/reference/openapi-specs/readme.md).

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

{% columns %}
{% column width="50%" %} <a href="https://openapi.gitbook.com/o/HctdcUHRfIWXBVA1egPp/spec/image-yaml.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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.