> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/getting-started/api.md).
# Access Appmixer REST API
Appmixer offers a REST API that mirrors the functionalities accessible through its UI. This API enables advanced customizations, additional automations, and scripting capabilities for enhanced integration flexibility.
The base URL for the Appmixer REST API varies according to your specific Appmixer tenant. Throughout this documentation, it is referred to as `[TENANT_API_URL]`. Replace it with the API URL of your tenant, for example:
* `https://api-acme.appmixer.ai` for newer hosted tenants,
* `https://api.acme.appmixer.cloud` for older hosted tenants,
* the API URL of your own installation in case of a Self-Managed Appmixer.
Similarly, `[TENANT_STUDIO_URL]` refers to the URL of your Appmixer Studio, for example `https://acme.appmixer.ai` or `https://my.acme.appmixer.cloud`, and `[TENANT_BACKOFFICE_URL]` to the URL of your Appmixer Backoffice, for example `https://backoffice-acme.appmixer.ai` or `https://backoffice.acme.appmixer.cloud`.
The majority of the Appmixer API endpoints require authentication using an access token associated with an Appmixer user account. Certain endpoints may require that this user to has the `admin` scope; specific requirements are detailed at each endpoint's documentation. To obtain a user's access token, sign in using the user's credentials:
```bash
$ curl -XPOST "[TENANT_API_URL]/user/auth" \
-H "Content-type: application/json" \
-d '{ "username": "abc@example.com", "password": "abc321" }'
```
On success, Appmixer returns a JSON object structured as follows:
```json
{
"user": {
"id": "5c88c7cc04a917256c726c3d",
"username":"abc@example.com",
"email": "abc@example.com"
},
"token":"eyJhbGciOiJIUzI1NiIsInR5cC..."
}
```
Use the `token` in the `Authorization` header to authenticate your user to the Appmixer API. For example:
```
$ curl "[TENANT_API_URL]/flows" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cC..."
```
Find the full documentation to the REST API [here](/api/authentication.md).
## OpenAPI Specification
The REST API is also described by an [OpenAPI 3.1](https://spec.openapis.org/oas/v3.1.0) specification. Import it into tools such as Postman, Insomnia or Swagger UI to explore the API, generate API clients in your programming language, or give AI agents a machine-readable description of the API. Set the `tenantApiUrl` server variable to your `[TENANT_API_URL]`.
{% file src="/files/BOjcLdEPDyo7rPjrN2G5" %}
---
# 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.appmixer.com/getting-started/api.md?ask=&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.