> For the complete documentation index, see [llms.txt](https://docs.tpi.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tpi.dev/guide/api-management/api-test.md).

# API Test

<mark style="color:green;">**Path: API Management > API Test**</mark>

In this section, you can find instructions on how to verify the usability of registered APIs.

1. Fill in the data or make selections as instructed below. The fields marked with “<mark style="color:red;">\*</mark>” are required.
   * **digiRunner URL**<mark style="color:red;">\*</mark>: Fill in the API URL, and for composite APIs, the client call format is `/tsmpc/{module name}/{API ID}`.
   * **Authorization:** Select the authorization type for testing.
   * **Request Header:** Click on the ![](https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/RG4T0zf4QRh38QKibFwv/image.png) icon to add items.
   * **Request Body:** Select the request body type.
2. Click **Test** to run the API test, and the result will be displayed in the **Response** field.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/VBxyTmlz41B4TCFF5ESr/image.png" alt=""><figcaption></figcaption></figure>

3. Check the test result in the **Response** field. If the **Status** is *201* and data is displayed in both the **Headers** and **Body**, the API is functioning correctly and is ready for use. If the response status is 201 and data is displayed in both the Request Header and Request Body, the API is functioning correctly and is ready for use.

<figure><img src="https://content.gitbook.com/content/0choIC1BbdPOkKWOYGgk/blobs/UqYivcdbVl9hjn28vil5/image.png" alt=""><figcaption></figcaption></figure>


---

# 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://docs.tpi.dev/guide/api-management/api-test.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.
