Vertesia

Vertesia Interactions API

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.

GitHub OpenAPI

Operations 33

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 #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/openapi/vertesiahq-interactions-api-openapi.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/vertesiahq:vertesiahq-interactions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vertesiahq-interactions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Vertesia Interactions API
  version: 1.6.0-dev.20261019.172735Z
  x-api-version: '20260803'
  description: The Vertesia API provides project-scoped access to interaction execution and content workflows. Use it to run interactions, inspect execution history, stream run progress, replay previous executions, and search content objects and collections. Authenticate requests with a bearer token, or use the official `@vertesia/client` package for typed access from Node.js applications.
  contact:
    name: Vertesia
    url: https://vertesiahq.com/
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  x-scalar-sdk-installation:
  - lang: Node
    description: 'Install the **Vertesia Client** from npm:'
    source: npm install @vertesia/client
servers:
- url: https://api.{region}.vertesia.io/api/v1
  description: Vertesia API
  variables:
    region:
      default: us1
      enum:
      - us1
      - eu1
      - jp1
      description: Regional API host label. `us1` is the global endpoint.
tags:


# --- truncated at 32 KB (235 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vertesiahq/refs/heads/main/openapi/vertesiahq-interactions-api-openapi.yml