> For the complete documentation index, see [llms.txt](https://help.visuary.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.visuary.com/guide-visuary-en/settings-and-subscriptions/visuary-api.md).

# Visuary API

*Visuary's API lets external software or tools interact with certain Visuary data and features.*\
*It can be used, in particular, to automatically retrieve information or exports related to your projects, so they can be integrated into another tool or used to create automations.*

{% hint style="success" icon="lightbulb" %}
**For the full technical documentation, go to this link:** \
[**https://dev.visuary.com/**](https://dev.visuary.com/)
{% endhint %}

### Create a token

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZFcDkdPcFkKsLAju8DW3%2Fuploads%2FGavC7u14rozenyb1QSNs%2Fcreation_token.mp4?alt=media&token=773a79de-422a-4a11-8d8e-e9e43b886040>" %}

To create a token:&#x20;

1. On the home page, click the**gear icon** at the bottom left to open the **user settings**
2. Scroll to the bottom of the page, in the **"API access"**
3. Click **"+ Create a token"**.
4. **Give the token a descriptive name** ; this name is only there to help you identify it (for example: `export-script`, `ci-pipeline`).
5. **Copy the token value** ; <mark style="background-color:$warning;">it will only be shown once and cannot be retrieved later</mark>.
6. Click **"Confirm"** to confirm token creation.

{% hint style="warning" %}
If the token is valid and your account has the necessary rights, the API will process the request. If the token is missing or invalid, the request will be rejected.\
Likewise, **a valid token can be refused if the account does not have the permissions or the Floor level required to access the requested resource**.
{% 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://help.visuary.com/guide-visuary-en/settings-and-subscriptions/visuary-api.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.