> For the complete documentation index, see [llms.txt](https://docs.screendesk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.screendesk.io/helpdesk-integrations/gist.md).

# Gist

How to request and send screen recordings with Gist

## Inbox

### Request Recording

You need to create a snippet for each of your agent in order to request recordings from your Gist inbox. Please follow the steps outlined below:

1. Get your personal recording link from the Screendesk dashboard. You will need to get the recording link of each of your agent.

<figure><img src="https://3820804400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfW6XSzJSKsNyZnOkSJPt%2Fuploads%2FwAqBAYwUwRWpI2Fe138S%2Fpersonal%20request%20link.png?alt=media&amp;token=d198d355-1bf8-493b-829c-22abb17d6c09" alt=""><figcaption></figcaption></figure>

2. Visit the **settings** tab in the Gist dashboard. Now visit the **inbox** dropdown and click on **conversation snippets**. Then paste your recording link in the new snippet.

{% hint style="danger" %}
Make sure to replace the src param from rria to gist

<https://app.screendesk.io/recordings/new?ak=0ZMy1g\\&key=lcmcFA\\&src=gist&**ce=\\{{> contact.email | default: ' '}}\*\*
{% endhint %}

<figure><img src="https://3820804400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfW6XSzJSKsNyZnOkSJPt%2Fuploads%2FENlGyvHGbPpLQ8Nwm9KO%2Fadd%20request%20link%20to%20snippet.png?alt=media&amp;token=ab6c4224-0102-4ba3-b601-3bcc48ea820f" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
You can identify your users by adding the url parameter **ce** to the link. That way screendesk will automatically map the user to the recording.

e.g: <https://app.screendesk.io/recordings/new?ak=0ZMy1g\\&key=lcmcFA&**src=gist**\\&ce=\\{{> contact.email | default: ' '}}
{% endhint %}

3. Use the newly created snippet in the inbo&#x78;**.**

<figure><img src="https://3820804400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfW6XSzJSKsNyZnOkSJPt%2Fuploads%2FYnefqcVzgpw6GLgWO15i%2Frequest%20link.gif?alt=media&amp;token=ef41e1eb-5899-443f-8f25-3b97737fdf99" alt=""><figcaption></figcaption></figure>

4. Users will then be prompted to paste the recording url in the chat when they are done recording.

<figure><img src="https://3820804400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfW6XSzJSKsNyZnOkSJPt%2Fuploads%2FbgE1kRTz2AAAjKCjn5vz%2FCleanShot%202024-08-13%20at%2012.54.42%402x.png?alt=media&amp;token=fdc840d5-970f-4ead-b20d-284b7765c697" alt=""><figcaption></figcaption></figure>

## Chats

You can customize the messages sent in your chats by simply adding your personal recording link. You can link the users to the recording by adding the **URL parametter ce** with the email address of the user.

<figure><img src="https://3820804400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfW6XSzJSKsNyZnOkSJPt%2Fuploads%2FkknGQhw2uvxEyDDBxwzr%2FCleanShot%202024-08-13%20at%2012.41.37%402x.png?alt=media&amp;token=4aaa1d3a-1bfd-42e3-81cd-734bbdd600f1" alt=""><figcaption></figcaption></figure>

## Bots

You can customize the messages sent in your bots by simply adding your personal recording link. You can link the users to the recording by adding the **URL parametter ce** with the email address of the user.

<figure><img src="https://3820804400-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfW6XSzJSKsNyZnOkSJPt%2Fuploads%2Fln8hJwT0zDYo2u6RmLqu%2FCleanShot%202024-08-13%20at%2012.45.15%402x.png?alt=media&amp;token=9792ff78-b244-4790-9e18-8d7e038a44a6" 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.screendesk.io/helpdesk-integrations/gist.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
