> For the complete documentation index, see [llms.txt](https://manual.firstresonance.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.firstresonance.io/api/interactive-api-explorer.md).

# Interactive API explorer

The ION UI application has a built-in API explorer to help you navigate the API

The ION UI application has a built-in API explorer to help you navigate the API. Click the API icon or go to <https://app.firstresonance.io/graphiql> .

![GraphiQL Explorer in ion](https://3615148728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LkRqYp6lJhwxjYdzYG8%2Fuploads%2Fgit-blob-b17a1fad4b766015556ad2fdd08365d089f5a9a8%2FScreen%20Shot%202019-10-04%20at%2011.58.33%20AM.png?alt=media)

From the interactive explorer, you can explore the data in your ION workspace, test queries, see the API function documentation, and even update data using the API mutations.

![The right column of the GraphiQL Explorer can be used to navigate the ION API](https://3615148728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LkRqYp6lJhwxjYdzYG8%2Fuploads%2Fgit-blob-81ebca17aac2c46ae1bd598db94f61c9e00f5f3c%2FScreen%20Shot%202019-10-04%20at%2012.01.56%20PM.png?alt=media)

## What Query or Mutation do you need?

As you scroll through the API explorer, you will notice that there are hundreds and thousands of API calls to choose from. ION is an API first platform, which is why there is a robust list of queries and mutations to pick from. This is incredibly powerful but can make it difficult to determine how to craft your API call.

Some amount of this you can start to intuitively understand as you play around with ION. For example, loading a run using the Run query, or creating inventory uses the createInventory mutation. Below are a few recommendations on how to help you determine what mutations and queries you need.

### Examples

A few example queries are provided in the GraphiQL Explorer to get you started. For additional functionality and API methods, you can navigate the API using the explorer in the right column of the GraphiQL Explorer. In addition, see our [Examples](/api/examples.md)for more details.

### Inspecting the Application

Using the network tab, you can see how ION uses API calls to surface and manipulate the data. If you right click, hit inspect, and navigate to the Network tab, you can click around in ION and see how our engineering team has used queries, mutations, filters, and more and that is perfect place to determine what queries and mutations you may need. Below is an example.

{% embed url="<https://www.loom.com/share/9b8da3d0ab2849da82c7a0601d8269ef?sid=69e764f6-c639-4642-9ec7-591300ef1e93>" %}

### API Glossary

Finally, check out the [Full Glossary of ION Permissions](/features/application-settings/role-based-access-control/full-glossary-of-ion-permissions.md)to see even more details.


---

# 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://manual.firstresonance.io/api/interactive-api-explorer.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.
