> For the complete documentation index, see [llms.txt](https://docs.aiplanet.com/genai-stack-1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aiplanet.com/genai-stack-1/rest-apis/chat-api-reference.md).

# Chat API Reference

Following are the steps to use `Test it` feature.

* Replace the {{url}} with the deployed url.
* Get the [api key](https://app.aiplanet.com/account/api-keys) from the GenAI Stack for authentication.
* Now you're ready to test the APIs.

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/health" method="get" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/apps" method="get" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/{stack\_app\_id}/chat-sessions" method="post" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/{stack\_app\_id}/chat-sessions/{chat\_session\_id}" method="get" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/{stack\_app\_id}/chat-sessions/{chat\_session\_id}" method="post" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/{stack\_app\_id}/chat-sessions/{chat\_session\_id}" method="patch" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/{stack\_app\_id}/chat-sessions/{chat\_session\_id}/uploads" method="get" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/{stack\_app\_id}/chat-sessions/{chat\_session\_id}/uploads" method="post" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}

{% openapi src="/files/x5sMnPYyupv7QiF3urn1" path="/api/v1/{stack\_app\_id}/chat-sessions/{chat\_session\_id}/uploads/{upload\_id}" method="get" %}
[output4.json](https://3489179498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FjlRjmrZThWiLNO9xTu9d%2Fuploads%2FIGCvoZ42r9ESTAPKOMLx%2Foutput4.json?alt=media\&token=4b91bc9b-e75c-4058-b566-5204bada8ead)
{% endopenapi %}