# Tooling

{% hint style="info" %}
The GraphQL API is an additional feature. If you would like to add the GraphQL Api to your Fast Weigh subscription, contact us at *865-219-2980* or <support@tacinsight.com>.
{% endhint %}

## Built-In Tooling

The GraphQL API offers built-in tooling so that you can get started immediately! You can access the built-in tooling by navigating directly to the endpoint.

`https://graphql.fast-weigh.com/`

{% embed url="<https://graphql.fast-weigh.com/>" %}

To get started with writing your first query, click the "Create Document" button. If you just want to browse the schema, click the "Browse Schema" button.

<figure><img src="/files/37KQZXATsb3mZEF3snLm" alt=""><figcaption></figcaption></figure>

### Authenticate With Your API Key

Navigate to the top-right of the screen, and click the settings gear to pull up the document's settings

<figure><img src="/files/INX2ad6Wfzifus1oSVfw" alt=""><figcaption></figcaption></figure>

Click the Authorization tab and set the Auth Type to "Bearer"

<figure><img src="/files/XYExKL7NWWrpby8uhJXE" alt=""><figcaption></figcaption></figure>

Enter your API Key in the Token field and click "Apply" to save

<figure><img src="/files/4xr9UjzygiWeywVoAWk8" alt=""><figcaption></figcaption></figure>

### **View Documentation**

Once your API key is pasted in, you can view the always-up-to-date data model docs.

Click the "Reload Schema" button to ensure the schema is up to date

<figure><img src="/files/XoHjoGladCWrYYqiKaEt" alt=""><figcaption></figcaption></figure>

Once you have refreshed, you'll have access to the documentation as well as query auto-completion within the editor. Just click "Schema" on the top-left to switch to the schema viewer.

<figure><img src="/files/V3OkfJzCIPUl7E1sJPY7" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/qA6vGhCIQ9IHMfsPbjn9" alt=""><figcaption></figcaption></figure>

### Using the Operator Builder

While you can hand-write your queries with the help of auto-complete, the built in tooling also offers a "Operator Builder" on the left side of the Operation tab

<figure><img src="/files/YFo0vFf8h5yvU3XVq9qh" alt=""><figcaption></figcaption></figure>

Once you open the builder, hit the "Create Query" button to get started

<figure><img src="/files/fadLuN9sjp6MlWKxaWgp" alt=""><figcaption></figcaption></figure>

There, you can find a Type and select the fields you want to see, any sub-types and fields, and even any "arguments" to build a "where clause" automatically<br>

<figure><img src="/files/keGkSUnCymtMJtBrT25U" alt=""><figcaption></figcaption></figure>

## Insomnia

We recommend using a tool called [Insomnia Client](https://insomnia.rest/products/insomnia) for query development and debugging. It has some great built-in features tailored for join REST and GraphQL development that make it quick and easy to get started.

[Grab the free download here](https://insomnia.rest/download)

### **Set Up Development Workspace**

Create an account or select "Use Local Scratch Pad"<br>

<figure><img src="/files/Ad4rNz3v1koua9Ts5T9U" alt=""><figcaption></figcaption></figure>

In the newest versions of Insomnia, a new Project will be auto-created when you create a new account.

<figure><img src="/files/IKUjEkyApyHQAgf8vWIi" alt=""><figcaption></figcaption></figure>

### Create a Collection (Optional)

If you would like to organize your requests, you can create a Collection within your Project on the left sidebar to house your requests.&#x20;

<figure><img src="/files/nyRXWrUxjXKKLsONwJ0S" alt=""><figcaption></figcaption></figure>

If you do not add a Collection manually, one will be created for you when you create your first request!

### **Create a GraphQL Request**

The easiest way to start a new GraphQL quest is by clicking the "+" button on the top-left of the sidebar, and then selecting GraphQL Request from the list

<figure><img src="/files/RthBZCPi0BJfTmesOdm6" alt=""><figcaption></figcaption></figure>

This will automatically set up the request for GraphQL, but you can do it manually, too! If you use the New HTTP Request button, make sure to update the "HTTP method" to "POST" and the "Body" tab's type to "GraphQL".

<figure><img src="/files/k6apzq4amS300uk6tWIG" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/FxX1FJTD6l0TqQEMBadb" alt=""><figcaption></figcaption></figure>

### **Add Your Endpoint**

In your request, fill in the URL/endpoint. `https://graphql.fast-weigh.com/`

<figure><img src="/files/C89sKBDVmkDYm4np0y8g" alt=""><figcaption></figcaption></figure>

### Authenticate With Your API Key

Navigate to the Auth tab, and set the authentication type to Bearer Token

<figure><img src="/files/eyytehEQCSeLClPyRuKa" alt=""><figcaption></figcaption></figure>

Enter your API Key in the Token field and set the Prefix to "Bearer"

<figure><img src="/files/u3uN0tAmvokHufkCvMcP" alt=""><figcaption></figcaption></figure>

### **View Documentation**

Once your API key and endpoint are pasted in, you can view the always-up-to-date data model docs without leaving Insomnia.

Back on the "Body" tab you should see a "schema" option at the top right of the query box.

<figure><img src="/files/qhXc2EBSbrbJGUHVkr7F" alt=""><figcaption></figcaption></figure>

Clicking on that will give you the option to refresh the schema. Doing so will fetch the latest data model from the server and build live documentation.

<figure><img src="/files/QdAu2lfH6Lwp5IntLWLF" alt=""><figcaption></figcaption></figure>

Once you have refreshed, you'll have access to the documentation as well as query auto-completion within the editor. Just click "Show Documentation" to bring up the schema sidebar.

<figure><img src="/files/1aBG9c5Jh3e7AbeE4RsK" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/Y6CzIRrw7dcZPamnWubU" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/KUxLruRCamERHM2ybEd0" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/BXbMWjr1PJOuV4wAAFVc" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: 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:

```
GET https://help.tacinsight.com/fast-weigh-knowledge-base/references/api-documentation/graphql-v2-api/tooling.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
