> For the complete documentation index, see [llms.txt](https://docs.reveel.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.reveel.id/use-cases/ai-agent-frameworks/elizaos-poc.md).

# ElizaOS POC

A proof-of-concept plugin that integrates Reveel Pay(ID) directly into the ElizaOS agent framework, enabling agents to search, authenticate, manage routes, and view transaction history using Pay(ID).

#### Plugin

* [plugin-reveel-payid](https://github.com/r3vl/plugin-reveel-payid)
* [PoC Docs](https://r3vl.notion.site/PoC-Eliza-1eafbc1efb8f8030b55ff7fb9a1f9848)
* [README](https://r3vl.notion.site/README-1eafbc1efb8f804bb86dc03c30a4e4f2)
* [Implementation Guide](https://r3vl.notion.site/Implementation-Guide-1eafbc1efb8f8048bf80d6feca3fe2a4)
* [Technical Spec](https://r3vl.notion.site/Technical-Specification-1eafbc1efb8f8063b5d5e8fc72a25152)

#### What it enables

* Each ElizaOS agent can be assigned a Pay(ID) and transact across chains
* Pay(ID) resolution and cross-chain payment triggering via the Reveel API
* Email-based sign-in and session management within the agent runtime
* Full transaction history retrieval for the authenticated agent

#### Agent actions

<table data-view="cards"><thead><tr><th></th></tr></thead><tbody><tr><td><p><strong>SEARCH_PAYID</strong></p><p></p><p>Search and resolve Pay(ID) identities across the network</p></td></tr><tr><td><p><strong>SIGNIN_WITH_FB</strong></p><p></p><p>Authenticate the agent session via email </p></td></tr><tr><td><p><strong>OTPGET_USER_ROUTES</strong></p><p></p><p>Fetch token and network routing preferences for the current agent</p></td></tr><tr><td><p><strong>GET_USER_TX_HISTORY</strong></p><p></p><p>Retrieve full transaction history for the authenticated agent</p></td></tr></tbody></table>

#### Installation

```
npm install @r3vl/plugin-reveel-payid
```

#### Example usage

{% code overflow="wrap" %}

```
// In your ElizaOS agent character config
import { reveelPayIdPlugin } from '@r3vl/plugin-reveel-payid'; 

export const character = { 
name: "MyAgent",
plugins: [reveelPayIdPlugin],
// ... }
```

{% endcode %}

#### How it works

* Install the plugin as part of the ElizaOS agent configuration
* Set environment variables for Reveel API authentication
* Agents can then resolve Pay(ID)s and trigger cross-chain payments via natural language
* Route rules are defined per agent — specifying preferred token and network


---

# 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.reveel.id/use-cases/ai-agent-frameworks/elizaos-poc.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.