> 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/about-graphql.md).

# About GraphQL

[GraphQL](https://graphql.org/) is a specification for defining an API schema, giving it types, and a way to relate data provided by the backend API. To understand more about GraphQL, and why it's a useful API specification, we found [Github's documentation](https://developer.github.com/v4/) helpful.

First Resonance adopted a GraphQL API for ION not only because it is becoming adopted by many API providers, but because of how fitting it is for manufacturing systems. Specifically, GraphQL allows clients to request and receive only the data it needs. In a complex manufacturing environment, this is important to maintain simplicity while still serving all of the various types of engineers working in manufacturing. Furthermore, the complex relationships across different processes and systems (e.g. Runs and Issues) is significantly better to relate and understand using the GraphQL specification over, e.g. REST.


---

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