> 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/6.0/5.0/appmixer-hosted/appmixer-api.md).

# Using Appmixer API

The Appmixer API allows you to access all the features that the UI works with via a REST API. You should have already received some user credentials when your *hosted* environment was created. Or you could have already tried the sign-up page (`https://my.[acme].appmixer.cloud`) and created other users. In order to access the data of the user via the API, you need to have their access token. Use the following API call to get the token (don't forget to replace the "<abc@example.com>" and "abc321" with your own user's username and password):

```bash
curl -XPOST "https://api.[acme].appmixer.cloud/user/auth" -d '{"username": "abc@example.com", "password": "abc321"}' -H 'Content-Type: application/json'
```

You should see a response that looks like this:

```javascript
{"user":{"id":"5c88c7cc04a917256c726c3d","username":"abc@example.com","isActive":false,"email":"abc@example.com","plan":"free"},"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjODhjN2NjMDRhOTE3MjU2YzcyNmMzZCIsInNjb3BlIjpbInVzZXIiXSwiaWF0IjoxNTUyNDkzMTA0LCJleHAiOjE1NTUwODUxMDR9.sdU3Jt2MjmVuBNak0FwR0ETcjleRyiA6bqjMPA6f-ak"}
```

Copy the `token` and use it to authorize the user in your next API calls. For example, to get the number of flows the user created, use:

```bash
curl "https://api.[acme].appmixer.cloud/flows/count" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjODhjN2NjMDRhOTE3MjU2YzcyNmMzZCIsInNjb3BlIjpbInVzZXIiXSwiaWF0IjoxNTUyNDkyNjA5LCJleHAiOjE1NTUwODQ2MDl9.9jVcqY0qo9Q_1GeK9Fg14v7OrdpWvzmqnv4jDMZfqnI"
```

You should see a response that tells you how many flows the user has in their account:

```javascript
{"count":5}
```

Please see the [API](https://docs.appmixer.com/appmixer/api/flows) section to learn more about all the endpoints that you use.


---

# 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/6.0/5.0/appmixer-hosted/appmixer-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.