# Vertesia Interactions API

**Canonical:** https://apis.io/apis/vertesiahq/vertesiahq-interactions-api/  
**Provider:** Vertesia — https://apis.io/providers/vertesiahq/  
**Base URL:** https://api.us1.vertesia.io/api/v1  
**Documentation:** https://vertesiahq.com/docs

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

Interactions define executable GenAI tasks. Use these endpoints to create drafts, inspect and update definitions, publish immutable versions, fork interactions, resolve executable environment and model choices, execute interactions, and export interaction definitions.

## Operations (33)

| Method | Path | Summary |
|---|---|---|
| GET | `/interaction-configurations/{interactionId}` | Get saved code interaction configuration |
| PUT | `/interaction-configurations/{interactionId}` | Create or update code interaction configuration |
| DELETE | `/interaction-configurations/{interactionId}` | Remove code interaction configuration |
| GET | `/interactions/catalog/sys` | List system interactions |
| GET | `/interactions/catalog/apps/{appName}` | List app interactions |
| GET | `/interactions/catalog/apps` | List all app interactions |
| GET | `/interactions/catalog/stored` | List stored catalog interactions |
| GET | `/interactions/catalog/resolve/{interactionId}` | Resolve catalog interaction |
| GET | `/interactions` | List interactions |
| POST | `/interactions` | Create an interaction |
| GET | `/interactions/tags` | List interaction tags |
| POST | `/interactions/endpoints` | List interaction endpoints |
| GET | `/interactions/versions/{name}` | List interaction versions by name |
| GET | `/interactions/resolve/{nameOrId}` | Resolve an interaction |
| POST | `/interactions/facets` | Compute interaction facets |
| GET | `/interactions/names` | List interaction names |
| POST | `/interactions/export` | Export interactions |
| POST | `/interactions/improve` | Improve prompt content |
| GET | `/interactions/{interactionId}` | Retrieve an interaction |
| PUT | `/interactions/{interactionId}` | Update an interaction |
| DELETE | `/interactions/{interactionId}` | Delete an interaction |
| GET | `/interactions/{interactionId}/versions` | List interaction versions |
| GET | `/interactions/{interactionId}/forks` | List interaction forks |
| POST | `/interactions/{interactionId}/publish` | Publish an interaction |
| POST | `/interactions/{interactionId}/fork` | Fork an interaction |
| POST | `/interactions/{interactionId}/generate-interaction` | Generate an interaction |
| POST | `/interactions/{interactionId}/generate-test-data` | Generate interaction test data |
| POST | `/interactions/{interactionId}/suggest-prompt-improvements` | Suggest prompt improvements |
| POST | `/interactions/{interactionId}/execute` | Execute an interaction |
| POST | `/execute` | Execute an interaction by selector |
| POST | `/execute/async` | Execute an interaction asynchronously |
| POST | `/execute/{endpoint}` | Execute an interaction by endpoint |
| POST | `/execute/rate-limit/request` | Request an interaction rate-limit slot |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/openapi/vertesiahq-interactions-api-openapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-agent-run-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-update-app-payload-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-app-manifest-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-app-manifest-data-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-indexing-status-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/json-schema/vertesiahq-dashboard-schema.json

## Other Vertesia APIs (12)

- [Vertesia Access Control Entries API](https://apis.io/apis/vertesiahq/vertesiahq-access-control-entries-api/)
- [Vertesia Account API](https://apis.io/apis/vertesiahq/vertesiahq-account-api/)
- [Vertesia Accounts API](https://apis.io/apis/vertesiahq/vertesiahq-accounts-api/)
- [Vertesia Agent Runs API](https://apis.io/apis/vertesiahq/vertesiahq-agent-runs-api/)
- [Vertesia API Keys API](https://apis.io/apis/vertesiahq/vertesiahq-api-keys-api/)
- [Vertesia Apps API](https://apis.io/apis/vertesiahq/vertesiahq-apps-api/)
- [Vertesia Audit Trail API](https://apis.io/apis/vertesiahq/vertesiahq-audit-trail-api/)
- [Vertesia Bulk Operations API](https://apis.io/apis/vertesiahq/vertesiahq-bulk-operations-api/)
- [Vertesia Collections API](https://apis.io/apis/vertesiahq/vertesiahq-collections-api/)
- [Vertesia Commands API](https://apis.io/apis/vertesiahq/vertesiahq-commands-api/)
- [Vertesia Content Object Types API](https://apis.io/apis/vertesiahq/vertesiahq-content-object-types-api/)
- [Vertesia Content Query API](https://apis.io/apis/vertesiahq/vertesiahq-content-query-api/)

## Tags

Interactions

---

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