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

Vertesia Processes API

Process endpoints manage versioned process definitions, revisions, publishing, rollback, and isolated process test suites and test runs.

Vertesia Processes 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 Processes. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 20 operations across 13 paths, and defines 83 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.

20 operations 13 paths 83 schemas 3 DELETE7 GET8 POST2 PUT

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
License
Apache-2.0
Resource Areas
1

Authentication & Security 2

Vertesia Processes 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 20

Across 13 paths, the API surfaces 20 operations — 3 DELETE, 7 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Processes 20

Process endpoints manage versioned process definitions, revisions, publishing, rollback, and isolated process test suites and test runs.

GET
/processes
List process definitions
ListProcessDefinitions 6 params → 2005004XX
POST
/processes
Create a process definition
CreateProcessDefinition 1 param body → 2015004XX
GET
/processes/{processId}/versions
List process definition versions
ListProcessDefinitionVersions 2 params → 2005004XX
GET
/processes/{processId}/test-suites
List process test suites
ListProcessTestSuites 2 params → 2005004XX
POST
/processes/{processId}/test-suites
Create process test suite
CreateProcessTestSuite 2 params body → 2015004XX
PUT
/processes/{processId}/test-suites/{suiteId}
Update process test suite
UpdateProcessTestSuite 3 params body → 2005004XX
DELETE
/processes/{processId}/test-suites/{suiteId}
Delete process test suite
DeleteProcessTestSuite 3 params → 2005004XX
POST
/processes/{processId}/test-runs
Start process test run
StartProcessTestRun 2 params body → 2015004XX
GET
/processes/{processId}/test-runs
List process test runs
ListProcessTestRuns 3 params → 2005004XX
GET
/processes/{processId}/test-runs/{runId}
Retrieve process test run
GetProcessTestRun 3 params → 2005004XX
POST
/processes/{processId}/test-runs/{runId}/cancel
Cancel process test run
CancelProcessTestRun 3 params → 2005004XX
GET
/processes/{processId}
Retrieve a process definition
GetProcessDefinition 2 params → 2005004XX
PUT
/processes/{processId}
Update a process definition
UpdateProcessDefinition 2 params body → 2004095004XX
DELETE
/processes/{processId}
Delete a process definition
DeleteProcessDefinition 2 params → 2005004XX
POST
/processes/{processId}/publish
Publish a process definition
PublishProcessDefinition 2 params body → 2004095004XX
POST
/processes/{processId}/revert
Revert a process definition
RevertProcessDefinition 2 params body → 2004095004XX
POST
/process-test-runs
Submit a process test run
SubmitProcessTestRun 1 param body → 2015004XX
GET
/process-test-runs/{runId}
Retrieve a process test run by id
GetProcessTestRunById 2 params → 2005004XX
DELETE
/process-test-runs/{runId}
Delete a process test run
DeleteProcessTestRun 2 params → 2005004XX
POST
/process-test-runs/{runId}/cancel
Cancel a process test run by id
CancelProcessTestRunById 2 params → 2005004XX

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are NodeDefinition (38 properties), ProcessTestRun (16 properties), ProcessDefinition (15 properties), ProcessTestScenarioResult (14 properties). Each schema is shown below with its type and property counts.

ProcessScriptSource
ProcessTestFixtureResult
object
5 properties 1 required
ProcessBudgetSummary
object
8 properties 3 required
ProcessTestResolvedSubject
object
3 properties 2 required
ProcessTestRunArray
array
ProcessNodeRunType
string
ProcessTestScenarioResult
object
14 properties 10 required
ProcessTestTargetWithDefinition
object
1 property 1 required
ProcessTestChildTrace
object
8 properties 6 required
ProcessTestFixtureError
object
3 properties 3 required
JSONValue
ProcessAgentPhaseReset
object
3 properties 2 required
ProcessAgentToolInputContains
object
4 properties 2 required
ProcessAgentToolPhase
object
8 properties 3 required
PublishProcessDefinitionPayload
object
5 properties 1 required
ProcessDefinition
object
15 properties 12 required
ProcessNodeType
string
ProcessNodeReturnsDefinition
object
2 properties
NodeHistoryEntry
object
14 properties 3 required
ProcessTestSuiteArray
array
JSONSchemaProperties
object
RevertProcessDefinitionPayload
object
2 properties 1 required
StringValueMap
object
ProcessTestSubject
object
1 required
ProcessHistoryRef
object
3 properties 3 required
NodeDefinition
object
38 properties 1 required
BranchNodeBranchDefinition
object
5 properties 2 required
JSONSchema
object
9 properties
ProcessTestVirtualActor
object
4 properties 3 required
ProcessDefinitionBody
object
9 properties 5 required
ProcessTestInlineSubject
object
1 property 1 required
ProcessTestNodeFixture
object
4 properties 2 required
ProcessResourcesDefinition
object
1 property
TransitionDefinition
object
5 properties 1 required
ProcessTestAssertions
object
7 properties
DeleteCountResult
object
2 properties 2 required
ParallelCollectField
string
ParallelCollectMode
string
ProcessState
object
7 properties 4 required
ParallelCollectDefinition
object
3 properties 1 required
TaskField
object
6 properties 2 required
ProcessScriptResourceMap
object
ProcessScriptInlineSource
object
Script files stored directly in the process definition. The source is a discriminated object so artifact- and Git-backed sources can be added without changing…
2 properties 2 required
JSONObject
object
ProcessTestStoredSubject
object
3 properties 3 required
ProcessTestTarget
HumanTaskDefinition
object
4 properties 2 required
UpdateProcessTestSuitePayload
object
3 properties
UpdateProcessDefinitionPayload
object
7 properties
ProcessTestRunStatus
string
CreateProcessTestSuitePayload
object
3 properties 2 required
ProcessTestTargetById
object
2 properties 1 required
ProcessDefinitionFormatVersion
number
ProcessAgentExecutionPolicy
object
11 properties 1 required
ProcessDefinitionMetadata
object
Permission
string
CreateProcessDefinitionPayload
object
6 properties 2 required
ProcessDefinitionStatus
string
ProcessTestScenario
object
9 properties 7 required
NodeDefinitionMap
object
TaskFieldType
string
ProcessScriptLanguage
string
ProcessTestFixtureResponse
object
1 required
ProcessTestAssertionResult
object
5 properties 2 required
ProcessScriptResource
object
4 properties 3 required
ProcessTestHumanAction
object
5 properties 4 required
BranchJoinPolicy
string
JsonLogicRule
object
ProcessTerminalReason
string
Why a process run ended other than by reaching a final node. tokenbudgetexhausted: the run spent its token budget; it ends with status failed.
ProcessDefinitionRevisionInfo
object
5 properties 2 required
TransitionTrigger
string
ProcessTestActorDecision
object
4 properties 3 required
ProcessTestSuite
object
11 properties 10 required
SubmitProcessTestRunPayload
object
3 properties 2 required
ProcessDefinitionArray
array
ProcessContextDefinition
object
2 properties 2 required
ErrorResponse
object
Standard JSON error response returned by the server error handler.
5 properties 2 required
ProcessTestCoverage
object
4 properties 4 required
ParallelFailurePolicy
string
StartProcessTestRunPayload
object
4 properties 2 required
ProcessTestRun
object
16 properties 11 required
ProcessBudgetState
object
11 properties 3 required
BranchDefinition
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vertesiahq-processes-api-openapi.yml Raw ↑

Other APIs Vertesia publishes across the network.

Vertesia Access Control Entries API
Vertesia Account API
Vertesia Accounts API
Vertesia Agent Runs API
Vertesia API Keys API
Vertesia Apps API
Vertesia Audit Trail API
Vertesia Bulk Operations API
Vertesia Collections API
Vertesia Commands API
Vertesia Content Object Types API
Vertesia Content Query API
Where this information came from

This is an independent, third-party profile of Vertesia Processes 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.