# Ava API

**Canonical:** https://apis.io/apis/getava-xyz/getava-xyz-api/  
**Provider:** Ava — https://apis.io/providers/getava-xyz/  
**Base URL:** https://ava-v4-api.fly.dev  
**Documentation:** https://getava.xyz/docs

Ava API is one of 2 APIs that [Ava](https://apis.io/providers/getava-xyz/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Ava API as documented publicly: 18 operations. Contract generated from the documentation by API Evangelist (2026-11-09); not the provider's own document.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| POST | `/` | POST / |
| GET | `/health` | Liveness, degraded flag and dependency modes. |
| GET | `/matrix.json` | GET /matrix.json |
| GET | `/v1/agents/{agentinstanceid}/record` | The agent's track record. Owner‑only unless the owner opted it public. |
| POST | `/v1/agents/{agentinstanceid}/record/visibility` | Sets the record visibility. |
| GET | `/v1/capabilities` | Adapters, brokers, wallet providers and their current mode. |
| POST | `/v1/lend/execute` | ava_lend_execute Execute a REAL lend against one of your mandates. |
| GET | `/v1/mandates` | Lists your mandates, filterable by portal, agent instance and status. |
| POST | `/v1/mandates` | Creates a mandate from structured fields or from a natural‑language message. |
| POST | `/v1/mandates/{id}/evaluate` | Tests the mandate's conditions. Omit the snapshot and Ava pulls a live price for the condition asset. |
| GET | `/v1/portal/catalog` | Portals, their chains and their wallet families. |
| GET | `/v1/portfolio` | Simulated testnet portfolio for a userId (same data as GET /v1/portfolio). |
| GET | `/v1/receipts/{ref}/verify` | How are Ava receipts verified on chain? |
| GET | `/v1/receipts/exec_lend_aave_62d2a6763c984af8be707a58` | Get a receipt you can check |
| POST | `/v1/users/me/agents` | Registers an agent instance. |
| POST | `/v1/users/me/wallets/provision` | Provisions a custodial agent wallet in its own Turnkey sub‑organisation. |
| POST | `/v1/users/session` | POST /v1/users/session |
| POST | `/v1/workflows/execute` | Executes a workflow plan (used for swap legs such as 0x, uniswap_v3, etc.). |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/getava-xyz/openapi/_ae-authored/getava-xyz-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/getava-xyz/json-schema/getava-xyz-get-v1-receipts-exec-lend-aave62-d2-a6763-c984-af8-be707-a58-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/getava-xyz/json-schema/getava-xyz-post-v1-mandates-id-evaluate-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/getava-xyz/json-schema/getava-xyz-post-v1-mandates-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/getava-xyz/json-schema/getava-xyz-post-v1-users-session-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/getava-xyz/json-schema/getava-xyz-post-v1-mandates-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/getava-xyz/json-schema/getava-xyz-get-v1-agents-agentinstanceid-record-response-schema.json

## Other Ava APIs (1)

- [Ava API](https://apis.io/apis/getava-xyz/ava-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/getava-xyz/getava-xyz-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/getava-xyz/.