# API View

The API window in dqMan allows users to execute and test API calls to Veeva Vault. It provides a visual interface for managing requests and responses, making it easier to test and debug API calls.

## **Structure of the API Window**

### **API Collection Panel**

* Displays a list of available API endpoints, either from the standard Veeva Vault collection or the user’s custom collection.
* Allows organizing and managing API requests, including creating groups of customized requests.
* Allows users to search for APIs using filters.

In the User's API Collection, using the context menu, you can load, delete, or rename the selected API and generate an API script.

<figure><img src="/files/rlA0EpNeRX1YBcE63dpZ" alt=""><figcaption><p>The API View</p></figcaption></figure>

### **API Request Panel**

* HTTP Method: (GET, POST, PUT, DELETE) – used to specify the type of request.
* API URL: allows entering the API endpoint to be accessed.
* Parameters, Headers, and Body:
  * Enables adding necessary parameters for proper request execution.
  * Supports session variables such as {{sessionId}} for authentication.

The Variables panel enables users to store reusable values that can be referenced in API requests, making it easier to work with dynamic data and reducing manual input errors.

In this panel you can find the option to save the selected and optionally edited API to the user’s collection using the Save button. You also have the option to generate an API script based on the API data entered in the panel by clicking the Generate Script button.

### **API Response Panel**

* "Raw" Tab: displays the API response in raw format (JSON, XML, etc.).
* "Table" Tab: allows viewing the response in a tabular format, if available.
* HTTP Response Codes: (e.g., 200 OK, 400 Bad Request, 401 Unauthorized, etc.) for quick diagnostics.
* In the Raw tab, you can save the received API response as a JSON file using the Save button.
* In the Table tab, you can export the API response in CSV or Excel format using the available export buttons.

### **Request History Panel**

* Allows users to access and re-run previous API requests.
* Displays the endpoints and status of each request.

### **Status Bar**

* Indicates the success or failure of API requests.
* Displays the available API request limit (e.g., "Burst Limit: 1999 out of 2000").


---

# 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://docs.dqman.com/veeva-vault-edition-26.1/session-window-vql-mdl-api-api-script-picklists-file-staging/api-view.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.