> For the complete documentation index, see [llms.txt](https://docs.tonic.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tonic.ai/textual/tonic-textual-api/textual-rest-api.md).

# Textual REST API

The Tonic Textual REST API allows you to more deeply integrate Textual functions into your existing workflows.

You can use the REST API as another tool alongside the Textual application and the Textual Python SDK. The Python SDK supports the same actions as the REST API. We recommend the Python SDK for customers who already use Python.

You can download the Textual OpenAPI specification from:

<https://textual.tonic.ai/swagger/v1/swagger.json>

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Authentication</strong><br><br>Authentication requirements for the REST API.</td><td><a href="/textual/tonic-textual-api/textual-rest-api/rest-api-authentication.md">REST API authentication</a></td></tr><tr><td><strong>Redaction</strong><br><br>Use the REST API to redact text.</td><td><a href="/textual/tonic-textual-api/textual-rest-api/rest-api-redaction.md">Redaction</a></td></tr><tr><td><strong>Datasets</strong><br><br>Use the REST API to manage datasets and dataset files.</td><td><a href="/textual/tonic-textual-api/textual-rest-api/rest-api-datasets.md">Datasets</a></td></tr><tr><td><strong>Entity linking</strong><br><br>Use the REST API to link entity values.</td><td><a href="/textual/tonic-textual-api/textual-rest-api/entity-linking.md">Entity linking</a></td></tr><tr><td><strong>Access management</strong><br><br>Use the REST API to retrieve user information and to manage dataset access.</td><td><a href="/textual/tonic-textual-api/textual-rest-api/access-management.md">Access management</a></td></tr></tbody></table>


---

# 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://docs.tonic.ai/textual/tonic-textual-api/textual-rest-api.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.
