> For the complete documentation index, see [llms.txt](https://ask-clio.gitbook.io/ask-clio/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ask-clio.gitbook.io/ask-clio/tools-and-data-plug-in-your-apis/integrations-add-your-own-apis.md).

# Integrations: Add your own APIs

The Integrations tab lets you specify API endpoints for Clio to consider when deciding how to respond to a user query.

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

Step 1: Select the "Add API" button to get started.&#x20;

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

Step 2: Name the tool and describe how it should be used.&#x20;

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

Step 3: Add the API endpoint and request type, as well as any fixed (static) parameters or headers used in the call.

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

Step 5: Create the tool when you’ve populated all the static fields.

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

Step 6: Add parameters (Data Inputs) Clio will be responsible for populating. Clio will attempt to fill these based on the conversation.

* The "value" is the desciption provided to the model, so be precise on what should be included.&#x20;
* If you have added Dynamic Inputs, like your client ID, you can use securely here.&#x20;

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

Note: Data Inputs can parameterize either the API call parameters.\
e.g. <https://www.test.com?param1=value1>

<figure><img src="https://lh7-rt.googleusercontent.com/slidesz/AGV_vUdoH_w5PyvE-B7Na7et6nB0zLnDWQx8b7rgGt1JPTHXjyHDV88d2HiZRlX2PVTDK5HaUZgttO1APvX4Js_wmE5q5JuFdqneyYcqQKViv0VpO8k8RQzQN77Dqedi0jyEPVzof3UoCw=s2048?key=cONTdluIsoeXk0kU8BMwww" alt=""><figcaption></figcaption></figure>

Note: Data Inputs can parameterize the URL path itself. In this case you must demarcate parameter name by curly brace\
e.g. <https://www.test.com/param1>

<figure><img src="https://lh7-rt.googleusercontent.com/slidesz/AGV_vUe-zmJF_2hIkg5tFtlyyhjrM3fya07QoWUTh1vBBcbwaURKWM733ZMZze1V2LpAi4oxOsSAcUARkImKRdI4h8ma2t_hY3E069crfLc-R0jHwaqjhPZSz_P9kSyg3e4kfykFeZhZ3w=s2048?key=cONTdluIsoeXk0kU8BMwww" alt=""><figcaption></figcaption></figure>

Testing: Test the API call with an input parameter and verify that the tool is set up correctly.&#x20;

<figure><img src="https://lh7-rt.googleusercontent.com/slidesz/AGV_vUfMzxFp8-cWAlx1tqVkooK_jRwlr_WWz6jtP5RKjFiTwDP4l4t8OfFxHYRpnxK8IZGvyPqF2BCcWrztzHb3J_75ROn5PfvNSTMHVon1K01zymbD_qwOe6PWveHUMTsJLQTQdeh2=s2048?key=cONTdluIsoeXk0kU8BMwww" alt=""><figcaption></figcaption></figure>

Setting it live: Enable the tool to allow Clio to have access to it.&#x20;

<figure><img src="https://lh7-rt.googleusercontent.com/slidesz/AGV_vUfrk2Y5basULVsyPceQtI3oBiWEf08eVg_-6JRtfF_OhInquQPeTL15H6A1d6SNFrJ3lTr4DmFK3UAo9ocSup2-Fi65U00qqUaIEo5vkpZDItBTNgvQdC5lfvD14P5WJBNP-q38yA=s2048?key=cONTdluIsoeXk0kU8BMwww" alt=""><figcaption></figcaption></figure>

Don't forget to save any changes!

<figure><img src="https://lh7-rt.googleusercontent.com/slidesz/AGV_vUfrk2Y5basULVsyPceQtI3oBiWEf08eVg_-6JRtfF_OhInquQPeTL15H6A1d6SNFrJ3lTr4DmFK3UAo9ocSup2-Fi65U00qqUaIEo5vkpZDItBTNgvQdC5lfvD14P5WJBNP-q38yA=s2048?key=cONTdluIsoeXk0kU8BMwww" alt=""><figcaption></figcaption></figure>

> **Note on Dynamic Inputs vs User Identity**
>
> Dynamic Inputs are intended for **resource or account identifiers** (for example, a clearing account ID, portfolio ID, or internal resource ID).
>
> Do not use Dynamic Inputs as a replacement for `user.id`.\
> `user.id` should always represent your application’s internal user identifier when creating session tokens.

**Read-only by default**\
By default, all Clio integrations are retrieval-only (GET-based). Clio does not perform user actions or destructive operations (e.g. trades, account modifications) unless explicitly configured by the client.


---

# 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://ask-clio.gitbook.io/ask-clio/tools-and-data-plug-in-your-apis/integrations-add-your-own-apis.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.
