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

# OpenAPI

## About

[OpenAPI](https://swagger.io/docs/specification/about/) is a standard specification for describing REST APIs. OpenAPI descriptions allow both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation. TextMaster has made its REST API publicly available as an OpenAPI 3.0 compliant document.

## Getting the OpenAPI description

You can find the description at <https://app.textmaster.com/api-docs/v1/clients/specs.yaml>

## Using the OpenAPI description

There are many uses for an OpenAPI description. For example, you could:

* Generate your own API client.
* Validate and test a TextMaster REST API integration.
* Explore and interact with the TextMaster REST API using third-party tools, such as Insomnia or Postman.

For example, TextMaster uses the OpenAPI description to generate the [REST API reference](/reference/abilities.md) documentation.

{% hint style="info" %}
**Tips:** You can also explore our API through [**our interactive interface**](https://app.textmaster.com/api-docs/index.html) allowing you to send and inspect request without having to write any code!
{% endhint %}


---

# 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 dynamically by asking a question.

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

```
GET https://developer.textmaster.com/quick-start/openapi.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.