> For the complete documentation index, see [llms.txt](https://docs.developers.symphony.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.developers.symphony.com/bots/overview-of-rest-api/agent-api.md).

# Overview of Agent API

## Symphony Messaging Agent APIs <img src="https://3121587452-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MB51RkjSmfA_ejydg4M%2F-MJh6xHp6XGkm0qZ6aBu%2F-MJh8dJszwD87ExJp6qu%2FSymphony%20API.png?alt=media&amp;token=e8f321ca-1419-4df2-9709-e32917b491ca" alt="" data-size="line">

The Symphony Messaging Agent is responsible for encryption and decryption of messages and content sent to and from a bot. As a result, the Agent API is used to build applications that send and receive messages and content. The following guide includes API collections that exist on the Agent:

## Message APIs <img src="https://3121587452-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MB51RkjSmfA_ejydg4M%2F-MJh6xHp6XGkm0qZ6aBu%2F-MJh8dJszwD87ExJp6qu%2FSymphony%20API.png?alt=media&amp;token=e8f321ca-1419-4df2-9709-e32917b491ca" alt="" data-size="line">

The Message APIs create, read and search messages on the Pod. These APIs can be used to do the following:

* Get messages
* Create messages
* Get attachments
* List attachments
* Import messages
* Suppress messages
* Search messages
* Get message status
* List message receipts

The full list of Messages API endpoints and their corresponding reference guide can be found here: <https://developers.symphony.com/restapi/main/messages>

## Datafeed APIs <img src="https://3121587452-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MB51RkjSmfA_ejydg4M%2F-MJh6xHp6XGkm0qZ6aBu%2F-MJh8dJszwD87ExJp6qu%2FSymphony%20API.png?alt=media&amp;token=e8f321ca-1419-4df2-9709-e32917b491ca" alt="" data-size="line">

The Datafeed APIs create and manage real-time event streams from the Pod to your bot. These APIs can be used to do the following:

* Create Datafeed
* Read Datafeed

For more information on how Symphony Messaging Datafeeds allow your bot to create rich and interactive workflows, navigate here:

{% content-ref url="/pages/-MB57aAcotIdE6grvSqr" %}
[Datafeed](/bots/datafeed.md)
{% endcontent-ref %}

The full list of Datafeed API endpoints and their corresponding reference guide can be found here: <https://developers.symphony.com/restapi/main/datafeed>

## Signal APIs <img src="https://3121587452-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MB51RkjSmfA_ejydg4M%2F-MJh6xHp6XGkm0qZ6aBu%2F-MJh8dJszwD87ExJp6qu%2FSymphony%20API.png?alt=media&amp;token=e8f321ca-1419-4df2-9709-e32917b491ca" alt="" data-size="line">

The Signal APIs create and manage tailored alerts based on mention or tag criteria. These APIs can be used to do the following:

* List signals
* Get signal details
* Create a signal
* Subscribe/Unsubscribe to a signal
* List signal subscribers

The full list of Signals API endpoints and their corresponding reference guide can be found here: <https://developers.symphony.com/restapi/main/signals>

## Basic APIs <img src="https://3121587452-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MB51RkjSmfA_ejydg4M%2F-MJh6xHp6XGkm0qZ6aBu%2F-MJh8dJszwD87ExJp6qu%2FSymphony%20API.png?alt=media&amp;token=e8f321ca-1419-4df2-9709-e32917b491ca" alt="" data-size="line">

This group of APIs perform testing and obtain diagnostics regarding the health of Symphony Messaging components. These APIs can be used to do the following:

* Perform a component health check
* Obtain Agent Info
* Perform an echo test
* Get session info

The full list of Basics API endpoints and their corresponding reference guide can be found here: <https://developers.symphony.com/restapi/main/info-health-check>


---

# 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.developers.symphony.com/bots/overview-of-rest-api/agent-api.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.
