How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vertesia

Vertesia Workflow Runs API

Workflow run endpoints start workflows, inspect execution state, stream updates, and apply runtime actions such as signaling or cancellation.

Documentation Provider Profile APIs.io OpenAPI GitHub

Vertesia Workflow Runs API is one of 48 APIs that Vertesia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Workflow Runs. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 11 operations across 11 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 1.6.0-dev.20261019.172735Z.

Requests are made against a single base URL, https://api.{region}.vertesia.io/api/v1.

11 operations 11 paths 62 schemas 5 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.6.0-dev.20261019.172735Z
Base URL
https://api.us1.vertesia.io/api/v1
Authentication
HTTP Bearer, OAuth 2.0
Contact
Vertesia
License
Apache-2.0
Resource Areas
1

Authentication & Security 2

Vertesia Workflow Runs API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 33 scopes.

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 5 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Workflow Runs 11

Workflow run endpoints start workflows, inspect execution state, stream updates, and apply runtime actions such as signaling or cancellation.

POST
/workflows/runs
List workflow runs
ListWorkflowRuns 1 param body → 2005004XX
GET
/workflows/runs/{workflowId}/{runId}/updates
Get workflow run updates
GetWorkflowRunUpdates 4 params → 2005004XX
GET
/workflows/runs/{workflowId}/{runId}/stream
Stream workflow run updates
StreamWorkflowRunUpdates 4 params → 2005004XX
POST
/workflows/runs/{runId}/updates
Post a workflow run update
PostWorkflowRunUpdate 2 params body → 2015004XX
GET
/workflows/runs/{workflowId}/{runId}
Retrieve a workflow run
GetWorkflowRun 6 params → 2005004XX
POST
/workflows/runs/{workflowId}/{runId}/signal/{signalName}
Signal a workflow run
SignalWorkflowRun 4 params body → 2004095004XX
GET
/workflows/runs/{workflowId}/{runId}/query/{queryName}
Query a workflow run
QueryWorkflowRun 4 params → 2005004XX
POST
/workflows/runs/{workflowId}/{runId}/actions/{action}
Apply an action to a workflow run
ApplyWorkflowRunAction 4 params → 2005004XX
POST
/workflows/execute/{workflowName}
Execute a workflow
ExecuteWorkflow 2 params body → 2005004XX
POST
/workflows/rules/{ruleId}/execute
Execute a workflow rule
ExecuteWorkflowRule 2 params body → 2005004XX
GET
/workflows/rules/{ruleId}/runs
List runs for a workflow rule
ListWorkflowRuleRuns 2 params → 2005004XX

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are AgentMessageDetails (32 properties), WorkflowRunWithDetails (24 properties), AgentTask (22 properties), WorkflowRun (21 properties). Each schema is shown below with its type and property counts.

SignalEventProperties
object
Signal event properties for workflow events
6 properties 1 required
PromptStatus
string
PromptSegmentDefType
string
WorkflowExecutionStatus
number
SignalTask
object
16 properties 9 required
AgentResourceAction
string
WorkflowQueryResult
SignalAgentResponse
object
Response from signaling an agent workflow.
2 properties 2 required
TaskType_CHILD_WORKFLOW
string
ExecuteWorkflowPayload
object
8 properties
WorkflowRun
object
21 properties 2 required
ActivityTask
object
12 properties 9 required
AgentTask
object
Agent task information for workflow history UI representation. This is separate from the analytics AgentEvent types. Consistent with WorkflowTask naming conven…
22 properties 6 required
PostAgentRunUpdatePayload
object
Payload for posting an update into an agent's workflow stream.
6 properties
AgentResourceReference
object
A navigable reference to a resource an agent tool mutated. Tools return these as tool-result metadata (see {@link ToolResultMeta.resources } ); the conversatio…
5 properties 4 required
ChildWorkflowTask
object
13 properties 9 required
TimerTask
object
14 properties 9 required
AgentMessageDetails
object
32 properties
WorkflowInputFile
object
File reference with URL and mimetype
2 properties 2 required
ListWorkflowRunsResponse
object
3 properties 1 required
SignalAgentPayload
object
Generic signal payload sent to a running agent workflow.
AgentCheckpointConfiguration
object
2 properties
CompactMessage
object
Compact message format for efficient wire transfer. Primary type used throughout the system. ~85% smaller than legacy AgentMessage format.
7 properties 1 required
InteractionVisibility
string
WorkflowRunUpdatesResponse
object
1 property 1 required
PlanTask
object
5 properties 2 required
TaskType_ACTIVITY
string
AgentResourceType
string
The kinds of Vertesia resource an agent tool can report having created, updated, or deleted. Restricted to resources that have a real detail route to navigate…
ExecutionTokenUsage
object
9 properties
WorkflowExecutionStartResultArray
array
JSONValue
TaskStatus
string
AgentBudgetConfiguration
object
Weighted token budget for an agent run and its subagent workstreams. A call is charged output × outputtokenweight + uncached input × inputtokenweight + cached…
8 properties
SkillContextTriggers
object
Context triggers for auto-injection of skills. When these conditions match, the skill is automatically injected into the agent context.
3 properties
AgentMessageType
number
WorkflowInput
object
1 required
InteractionRef
object
13 properties 7 required
PendingActivity
object
7 properties 3 required
TaskType_TIMER
string
ErrorResponse
object
Standard JSON error response returned by the server error handler.
5 properties 2 required
WorkflowExecutionStartResult
object
2 properties 2 required
ServerSentEventsResponse
string
AgentRunnerOptions
object
Configuration options for Agent Runner functionality. These options control how interactions are exposed and executed in the Agent Runner.
11 properties
AgentSearchScope
string
Defines the scope for agent search operations.
PromptRole
string
PromptTemplateRef
object
10 properties 7 required
WorkflowActionResponse
object
1 property 1 required
ConversationActivityState
string
FileProcessingStatus
string
Status of a file being processed for conversation use.
WorkflowUpdatePublishResponse
object
1 property 1 required
ConversationFile
object
Represents a file being processed in a conversation workflow.
13 properties 6 required
EventError
object
Error information from failed workflow events
4 properties
TaskType_SIGNAL
string
WorkflowHistory
object
1 required
WorkflowRunWithDetails
object
24 properties 2 required
ConversationVisibility
string
InteractionStatus
string
TemplateType
string
WorkflowTask
object
1 required
PromptSegmentRef_PromptTemplateRef
object
4 properties 2 required
ListWorkflowRunsPayload
object
16 properties
WorkflowRunEvent
object
11 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vertesiahq-workflow-runs-api-openapi.yml Raw ↑

Other APIs Vertesia publishes across the network.

Vertesia Access Control Entries API
AE Profile APIs.io
Vertesia Account API
AE Profile APIs.io
Vertesia Accounts API
AE Profile APIs.io
Vertesia Agent Runs API
AE Profile APIs.io
Vertesia API Keys API
AE Profile APIs.io
Vertesia Apps API
AE Profile APIs.io
Vertesia Audit Trail API
AE Profile APIs.io
Vertesia Bulk Operations API
AE Profile APIs.io
Vertesia Collections API
AE Profile APIs.io
Vertesia Commands API
AE Profile APIs.io
Vertesia Content Object Types API
AE Profile APIs.io
Vertesia Content Query API
AE Profile APIs.io
#Workflow Runs
← Back to V APIs
API Details
ID
vertesiahq:vertesiahq-workflow-runs-api
Base URL
https://api.us1.vertesia.io/api/v1
Docs
https://vertesiahq.com/docs
Provider
Vertesia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vertesiahq-workflow-runs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vertesiahq-workflow-runs-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Vertesia Workflow Runs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.