Vertesia Apps API
App endpoints manage app manifests, project installations, installation settings, and installation-scoped tool visibility.
Vertesia Apps 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 Application. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.
This API exposes 52 operations across 44 paths, and defines 334 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.
52 operations
44 paths
334 schemas
5 DELETE28 GET13 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Vertesia Apps 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 52
Across 44 paths, the API surfaces 52 operations — 5 DELETE, 28 GET, 13 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Apps 52
App endpoints manage app manifests, project installations, installation settings, and installation-scoped tool visibility.
GET
/apps/source-providers/github
Get App Builder GitHub provider configuration
POST
/apps/source-providers/github/authorize
Start GitHub authorization for an App Builder source
POST
/apps/source-providers/github/exchange
Verify GitHub App installations visible to the current user
GET
/apps/source-providers/github/repositories
List repositories accessible to a verified GitHub App installation
GET
/apps/source-providers/github/repository-setup
Inspect branches in a verified GitHub repository
GET
/apps/instance-availability
Check whether additional MCP app instances are enabled for this project
GET
/apps/{id}/repo/tree
List files in the app git repository
GET
/apps/{id}/repo/file
Read a file from the app git repository
POST
/apps/{id}/repo/documents
Commit documents to the app git repository
GET
/apps/{id}/repo/commits
List commits in the app git repository
GET
/apps/{id}/repo/refs
List branches and tags in the app git repository
GET
/apps/{id}/development-tasks
List app development tasks
GET
/apps/{id}/development-tasks/{taskId}
Get an app development task
POST
/apps/{id}/development-tasks/{taskId}/runs
Start an app development task run
POST
/apps/{id}/repo/branches
Create a branch in the app git repository
PUT
/apps/installations/{installId}/collections/{collectionId}/api-key
Set an installation MCP API key
GET
/apps/installations/{installId}/collections/{collectionId}/api-key
Read an installation MCP API key status
DELETE
/apps/installations/{installId}/collections/{collectionId}/api-key
Delete an installation MCP API key
PUT
/apps/{id}/collections/{collectionId}/api-key
Set the API key of an MCP tool collection
GET
/apps/{id}/collections/{collectionId}/api-key
Check whether an MCP tool collection has an API key
DELETE
/apps/{id}/collections/{collectionId}/api-key
Delete the API key of an MCP tool collection
GET
/apps/{id}/package
Get an app package by scope
GET
/apps/versions
List app versions
POST
/apps/versions
Record an app version
GET
/apps/versions/{id}
Get an app version
DELETE
/apps/versions/{id}
Delete an app version
POST
/apps/versions/{id}/promote
Promote an app version
POST
/apps/versions/{id}/rebuild
Rebuild an app version
POST
/apps/scaffolds
Start an app scaffold
GET
/apps/scaffolds/{workflowId}/{runId}/progress
Get app scaffold progress
POST
/apps/{id}/builds
Start an app build
GET
/apps/{id}/builds/{workflowId}/{runId}/progress
Get app build progress
POST
/apps
Create an app
GET
/apps
List apps
PUT
/apps/{id}
Update an app
DELETE
/apps/{id}
Delete an app
POST
/apps/install
Install an app
DELETE
/apps/install/{installId}
Uninstall an app
GET
/apps/installations/name/{name}
Retrieve an app installation by app name
GET
/apps/installations/projects
List projects for an app installation
GET
/apps/installations/{installId}/tools
List tools for an app installation
GET
/apps/installations/{installId}/package
Get an app installation package
GET
/apps/{id}/inspect
Inspect an app registration
GET
/apps/installations
List app installations
GET
/apps/installations/id/{installId}
Retrieve an authorized app installation by ID
GET
/apps/installations/all
List all app installations
GET
/apps/installations/refs
List app installation references
GET
/apps/installations/projects/{appName}
Get projects for an installed app
PUT
/apps/installations/settings/{app_id}
Update app installation settings
PUT
/apps/installations/{installId}/oauth-approval
Approve or revoke OAuth permissions for an app installation
PUT
/apps/installations/{installId}/tool-allowlist
Update app installation tool allowlist
POST
/apps/validate-url
Validate an app URL
Schemas 334
The contract defines 334 schemas that model the data the API accepts and returns. The most detailed are AutonomousRunResponse (55 properties), NodeDefinition (38 properties), AppVersionRecord (33 properties), ProgrammaticRunResponse (30 properties). Each schema is shown below with its type and property counts.
PromptSegmentDefType
string
AppInspectionIssue
object
A single diagnostic produced while inspecting an app's registration state.
4 properties
3 required
AppGitSourceProvider
string
AppWidgetInfo
object
3 properties
3 required
AppGithubConfiguration
object
4 properties
1 required
TwelvelabsPegasusOptions
object
4 properties
AppManifestSource
object
2 properties
2 required
SupervisedRunResponse
object
30 properties
12 required
PromptRole
string
VertexAIGeminiOptions
object
27 properties
McpApiKeyStatus
object
Whether an API key is configured for an MCP tool collection
2 properties
2 required
VertexAIClaudeOptions
object
12 properties
EmbeddingTypeEnabledMap
object
3 properties
PromptSegmentRef_PromptTemplateRef
object
4 properties
2 required
VertexAIGeminiOmniVideoOptions
object
5 properties
OpenAiAudioOptions
object
3 properties
AppAvailableIn
string
ViewBoardDisplay
object
8 properties
5 required
AppGithubBranchState
object
3 properties
3 required
ProcessHistoryRef
object
3 properties
3 required
DashboardElasticsearchResultMapping
object
How an Elasticsearch DSL result should be converted into Vega rows.
1 required
StartAppBuildRequest
object
6 properties
AgentRunEvaluation
object
Evaluation summary of an agent run.
10 properties
5 required
ViewSearchFieldType
string
AppGithubInstallation
object
4 properties
3 required
ProjectRefArray
array
BedrockCohereCommandOptions
object
10 properties
TransitionDefinition
object
5 properties
1 required
ParallelCollectField
string
DashboardStoreElasticsearchDataSource
object
Dashboard data source backed by Vertesia Store Elasticsearch DSL.
3 properties
2 required
BedrockMantleResponsesOptions
object
9 properties
AppCapabilities
string
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
BedrockMantleChatCompletionsOptions
object
8 properties
ThinkingLevel
string
AppInstallationArray
array
SemanticConditionOnError
string
HttpTimeoutOptions
object
HTTP timeouts applied to a driver's upstream LLM-provider calls. All values are in milliseconds. Drivers should map these onto whatever HTTP client their SDK u…
4 properties
EvaluationVerdict
string
LLM evaluation verdict for a turn.
ConfigModes
string
AppPackageScope
string
ProcessDefinitionFormatVersion
number
OpenAiSpeechOptions
object
5 properties
DashboardPanelPosition
object
Panel position within the dashboard grid.
4 properties
2 required
AppInspectionCapabilityReport
object
Per-capability report of what an app's promoted package actually exposes, compared against what its manifest declares.
4 properties
4 required
AgentRunEvaluationRollup
object
Fold of the turn evaluations of a run.
11 properties
7 required
AgentRunContradictionReason
string
DashboardQuery
object
Named SQL query that maps to a Vega data source. Supports parameterized SQL with {{paramname}} placeholders.
5 properties
2 required
ViewTermsNavigation
object
10 properties
4 required
NodeDefinitionMap
object
ImagenMaskMode
string
ProcessScriptLanguage
string
AppRepoRefs
object
The branches and tags of an app git repo (see {@link AppRepoRef } ).
3 properties
2 required
ProcessScriptResource
object
4 properties
3 required
AppInstallationOAuthBinding
object
Binding between an MCP collection and an OAuth provider created at install time. Stored on AppInstallation so the runtime can look up the correct OAuth provide…
3 properties
3 required
AppScaffoldProgress
object
11 properties
3 required
AppDeleteSummary
object
Result of DELETE /apps/:id. Doubles as the dry-run preview: without ?confirm=true the same shape comes back with deleted: false describing what the cascade wou…
9 properties
8 required
ProgrammaticRunResponse
object
30 properties
12 required
TransitionTrigger
string
VertesiaSDKToolCollectionObject
object
Vertesia SDK tool collection configuration
6 properties
2 required
ViewSelectionConfiguration
object
Client-side selection behavior for normalized View hits.
2 properties
1 required
AppOAuthCollectionParams
ParallelFailurePolicy
string
AppInstallationListEntryArray
array
RunSourceTypes
string
ProcessBudgetState
object
11 properties
3 required
OAuthClientCredentials
object
3 properties
PromptStatus
string
StartAppGithubAuthorizationResponse
object
1 property
1 required
EventSubscriptionFilter
object
6 properties
McpApiKeyCredential
object
1 property
1 required
AppScaffoldModule
string
ContentTypeExtractionGroundingReviewPolicy
object
5 properties
IntakePageRanges
array
Static page ranges: inclusive [start, end] pairs; negative indexes count from the end of the document ([[1, 2], [-1, -1]] = first two pages plus the last page).
ProcessNodeRunType
string
ContentTypeExtractionGroundingPolicy
object
16 properties
ProcessAgentToolInputContains
object
4 properties
2 required
AppInstallationWithManifestArray
array
OAuthClientCredentialsMap
object
OpenAiImageGenerationOptions
object
12 properties
1 required
AppInstallationProviderBinding
object
Binding between a named OAuth provider and the OAuth provider created for it at install time. Stored on AppInstallation so the runtime can resolve the correct…
3 properties
3 required
XAIGrokImageOptions
object
6 properties
StoredTypeRef
object
4 properties
3 required
BedrockGptOssOptions
object
9 properties
AppGithubRepositoryCreation
object
2 properties
1 required
InteractionSemanticEvaluator
object
Evaluates the semantic condition with a single LLM call (no tools). The event envelope — optionally enriched with an excerpt of the content object text — is cl…
5 properties
1 required
ViewActionConfiguration
object
Declarative action exposed by a View. The handler name is resolved by the embedding application; persisted configuration never contains executable code.
8 properties
3 required
MCPApiKeyConfig
object
Install-time provisioning blueprint for an auth: 'apikey' MCP collection. Declares whether the installer is prompted for the key. Never holds the key itself —…
2 properties
ViewBoardCardConfiguration
object
5 properties
1 required
AppInstallationPayload
object
11 properties
1 required
NodeHistoryEntry
object
14 properties
3 required
StringValueMap
object
AppUIConfig
object
5 properties
1 required
UpdateAppInstallationToolAllowlistPayload
object
1 property
1 required
EventPriority
string
AppManifest
object
29 properties
10 required
EventSemanticCondition
object
A natural-language predicate evaluated by an LLM after all structural filters (categories, actions, resource types, JSONLogic condition) have matched.
4 properties
1 required
AppRepoCommit
object
One commit that inserted or changed a file in an app git repository.
4 properties
2 required
AppInstanceAvailability
object
1 property
1 required
InteractionRef
object
13 properties
7 required
TurnEvaluationFlag
string
Reason behind an evaluation severity.
BranchNodeBranchDefinition
object
5 properties
2 required
Extract_AppVersionGitRefType_branch_tag_commit
string
MCPToolCollectionObject
object
MCP tool collection configuration (requires name, description, and namespace)
14 properties
6 required
DashboardDataSource
object
Data source for a Vega dashboard.
1 required
ProcessDefinitionBody
object
9 properties
5 required
GroqOptions
object
8 properties
1 required
DashboardElasticsearchDsl
object
Elasticsearch DSL supported by dashboard data sources. Queries execute through Vertesia Store, so project/security filtering remains server-side.
5 properties
AppDashboardDefinition
object
Dashboard definition contributed by an app package. App dashboard IDs are local to the app. The platform exposes them as app: : when listing or retrieving dash…
13 properties
1 required
ViewCardsDisplay
object
11 properties
4 required
AppAccessControl
string
Access control policy for an app installation. Declares which access surfaces are gated by per-user ACEs. - 'all' (default): every surface (UI portal, tool/end…
EvaluationOutcome
string
Outcome of an LLM evaluation run.
MCPOAuthConfig
object
Install-time OAuth provisioning blueprint for an MCP collection. Defines how to auto-create an OAuth provider when the app is installed. Does NOT affect runtim…
10 properties
OpenAiImageGenerationMask
object
2 properties
AppOAuthProviderParams
ProcessState
object
7 properties
4 required
AppRepoDocumentCommit
object
Result of committing one or more uploaded documents to an app repository.
4 properties
4 required
AzureFoundryChatOptions
object
10 properties
AppVersionTarget
string
ExchangeAppGithubAuthorizationRequest
object
2 properties
2 required
ContentObjectTypeStatus
string
AppDevelopmentTaskDetails
object
Development task details, including the latest parent assistant run when one exists.
5 properties
3 required
AppGithubRepositoryList
object
1 property
1 required
ViewTableDisplay
object
6 properties
4 required
ViewResultsConfiguration
object
8 properties
2 required
ViewBoardColumn
object
3 properties
2 required
AgentCheckpointConfiguration
object
2 properties
OpenRouterTextOptions
object
23 properties
HumanTaskDefinition
object
4 properties
2 required
AppRepoRef
object
A branch or tag in an app git repo, resolved to its latest commit.
5 properties
2 required
AppPackage
object
16 properties
BedrockClaudeOptions
object
13 properties
AppRepoCommits
object
Commit history in an app git repository, optionally filtered to a file.
4 properties
1 required
McpConnectionParameter
AnthropicClaudeOptions
object
13 properties
EvaluationSeverity
string
Worst deterministic detector level. none means no detector fired, not success.
ImagenTaskType
string
AppInspectionResult
object
Result of inspecting an app's registration: the resolved manifest state, what the promoted package actually exposes per capability, and diagnostics. This is th…
11 properties
7 required
TaskFieldType
string
RemoteActivityDefinition
object
Definition of a remote activity exposed by a tool server for use in DSL workflows. Remote activities are identified in workflow steps using colon-separated nam…
8 properties
1 required
RunSource
object
5 properties
5 required
AgentToolApprovalClass
string
Approval behavior class for a tool exposed to agents. - readonly: reads or inspects state without changing Vertesia, external systems, or user-visible artifact…
SemanticEvaluator
object
1 required
AppUINavItem
object
Additional navigation item for an app's UI configuration. Used in AppUIConfig.navigation to define sidebar navigation entries in CompositeApp shell contexts. I…
7 properties
3 required
JsonLogicRule
object
ViewAgenticSearchMode
string
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.
ViewCollectionNavigation
object
9 properties
3 required
PromoteAppVersionResponse
object
2 properties
1 required
ViewResultMedia
object
4 properties
1 required
AgentRunFeedbackEntry
object
One recorded rating on an agent run.
10 properties
5 required
AppBuildProgressStatus
string
ProcessContextDefinition
object
2 properties
2 required
AgentToolDefinition
object
Tool definition with optional activation control for agent exposure.
10 properties
2 required
AppRepoBranch
object
A newly created app repository branch.
3 properties
3 required
ViewActionSelectionRequirement
string
PromptTemplateRef
object
10 properties
7 required
AppScaffoldSourceMode
string
How App Builder should use a connected source repository. generate writes a starter app to an empty branch; existing only binds the repository.
SemanticConditionMode
string
DashboardLayout
object
Dashboard layout configuration.
4 properties
4 required
InitialToolCall
object
A tool invocation executed before the first model turn of a conversation. Results are injected into the initial context so the agent starts with them in hand.
4 properties
2 required
ViewExperienceScope
object
6 properties
BranchDefinition
object
4 properties
1 required
TemplateType
string
AgentSemanticEvaluator
object
Evaluates the semantic condition with a non-interactive agent run that may use tools to enrich its decision (fetch documents, inspect processes, ...). Slower a…
5 properties
1 required
ViewLocationNavigation
object
9 properties
3 required
ViewListDisplay
object
10 properties
4 required
EventCategory
string
OpenAiGptImageOptions
object
12 properties
ViewSearchConfiguration
object
6 properties
OpenAiTranscriptionOptions
object
2 properties
AppInstallation
object
19 properties
5 required
ProcessAgentPhaseReset
object
3 properties
2 required
AgenticViewSearchConfiguration
object
7 properties
BedrockMantleClaudeOptions
object
12 properties
ViewActionsConfiguration
object
3 properties
ViewAgenticExecutionConfiguration
object
14 properties
AgentRunFeedbackRating
string
Thumbs up or thumbs down on an agent run.
IntakeVisionDetail
string
Vision detail level names referenced by intake policies. The rendering profiles behind the names (dpi, max size, quality, color mode) are PLATFORM-defined and…
ProcessAgentToolPhase
object
8 properties
3 required
ViewSortOption
object
3 properties
3 required
BedrockPalmyraOptions
object
10 properties
ValidateUrlResponse
object
1 property
1 required
ProcessNodeType
string
ProcessNodeReturnsDefinition
object
2 properties
AppRepoTreeEntry
object
One entry in an app git-repo directory listing (see {@link AppRepoTree } ).
3 properties
3 required
DashboardSqlDataSource
object
Dashboard data source backed by a Data Platform SQL query.
4 properties
2 required
JSONSchemaProperties
object
InCodeProcessDefinition
object
6 properties
3 required
MCPOAuthConfigMap
object
CountResult
object
1 property
1 required
StartAppScaffoldRequest
object
11 properties
1 required
MCPToolAnnotations
object
Metadata hints from MCP tool annotations (per MCP spec).
5 properties
McpPublicParameter
object
5 properties
AppVersionKind
string
AppDevelopmentTask
object
A mutable app development task represented by an agent/ Git branch.
4 properties
3 required
AppToolCollectionArray
array
ToolCollectionAuthType
string
Authentication type for tool collections. - 'none': connect directly without credentials for MCP collections; does not disable authentication for Vertesia SDK…
UpdateAppInstallationOAuthApprovalPayload
object
Approve OAuth scopes for this project installation. An empty list revokes project approval.
1 property
1 required
InteractionStatus
string
InCodeViewDefinition
object
A View definition contributed by application code through the app package endpoint.
6 properties
3 required
TurnTerminalType
string
How an agent turn ended.
AppWidgetInfoMap
object
ParallelCollectMode
string
ResourceRef
object
9 properties
3 required
ProcessScriptResourceMap
object
ViewHierarchyLevel
object
5 properties
3 required
AppManifestData
object
24 properties
6 required
AgentRunStatus
string
Status of an agent run through its lifecycle.
ProjectRef
object
4 properties
3 required
AppScaffoldProgressStatus
string
ReasoningEffort
string
ViewHierarchyNavigation
object
A drill-down hierarchy assembled from independently mapped properties. Hierarchies represent one selected path, so multiselect may only be false. Selection ids…
8 properties
4 required
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
ViewResultFieldFormat
string
OpenAiDalleOptions
object
6 properties
AppVersionRecordArray
array
ViewKeyTermDefinition
object
6 properties
3 required
AgentRunFeedbackReasonCode
string
Why the run was rated the way it was.
AppVersionRecord
object
33 properties
10 required
AppBuildTrigger
string
AppGithubAccount
object
3 properties
2 required
AppInstallationWithManifest
object
20 properties
5 required
EventRef
object
11 properties
10 required
AgentRunArchiveState
string
Archive lifecycle state for an agent run. - none: No archive exists (default) - pending: Terminal status recorded; archive workflow triggered - archiving: Arch…
NovaCanvasOptions
object
13 properties
1 required
ViewUploadDropParameters
object
5 properties
ImagenOptions
object
19 properties
DurationValue
stringnumber
SystemRoles
string
ContentTypeIntakePolicy
object
Per-content-type policy for the standard intake workflows.
9 properties
IntakePageScope
string
Named page scope for intake conversion/extraction: everything or the locate-pass result. Static page ranges live in the sibling pageranges field (which wins wh…
AutonomousRunResponse
object
AgentRun — the client-facing stable identity for a running or completed agent. All operations use id as the sole identifier. Temporal workflow internals are ne…
55 properties
12 required
AppDevelopmentTaskList
object
Git-backed development tasks and the branch used for new tasks by default.
2 properties
1 required
DeleteAppVersionResponse
object
6 properties
5 required
AgenticViewRerankConfiguration
object
4 properties
AppVersionGitRefType
string
AgentRunType
string
How the agent run was created.
AppVersionStorage
object
9 properties
ContentObjectTypeRef
object
1 required
ConversationActivityState
string
PromptCacheMode
string
ViewActionPlacement
string
ViewDropConfiguration
object
A declarative result-area drop target. Stored JSON supports the built-in upload action only.
3 properties
1 required
ProcessScriptSource
BedrockMistralOptions
object
8 properties
InteractionExecutionConfiguration
object
14 properties
ProcessBudgetSummary
object
8 properties
3 required
AgentRunResponse
object
1 required
ProcessRunConfig
object
7 properties
ToolCollectionObject
object
1 required
ModelOptions
object
AppManifestArray
array
AppToolCollection
object
A description of the tools provided by an app
4 properties
2 required
JSONValue
StartAppScaffoldResponse
object
6 properties
4 required
ViewRangeNavigation
object
9 properties
5 required
RunDataStorageLevel
string
AgentRunLlmEvaluationResult
object
Latest LLM evaluation result for a run.
11 properties
7 required
StartAppDevelopmentTaskRequest
object
5 properties
3 required
AgentRunFeedbackCounts
object
Ratings over the retained feedback entries, one vote per rater: a user who rated the run and one of its answers counts once, by their latest rating.
4 properties
2 required
ConversationVisibility
string
AppBuildProgress
object
11 properties
3 required
ValidateUrlRequest
object
1 property
1 required
AppEventSubscriptionDefinition
object
An app-owned event subscription. Studio derives its project scope and delivery target from the app installation and referenced event hook.
8 properties
5 required
DSLRetryPolicy
object
The payload for a DSL retry policy.
5 properties
AppInstallationListEntry
object
20 properties
5 required
DashboardPanel
object
Dashboard panel with Vega/Vega-Lite visualization.
6 properties
4 required
BedrockConverseOptions
object
10 properties
VertexAIGrokOptions
object
5 properties
AppOAuthClientConfig
object
Standalone public PKCE OAuth. Installation automatically provisions an app client with these exact callback URLs.
1 property
1 required
ContentTypeEditingPolicy
object
Per-content-type policy for collaborative document editing.
1 property
UpdateAppPayload
object
25 properties
6 required
NodeDefinition
object
38 properties
1 required
JSONSchema
object
9 properties
AppSourceConfig
object
2 properties
1 required
McpSecretParameter
object
4 properties
1 required
SetMcpApiKeyRequest
object
1 property
1 required
BedrockAI21Options
object
9 properties
ViewSortClause
object
2 properties
2 required
StartAppBuildResponse
object
7 properties
3 required
AppPackageEventHook
object
An authenticated event hook exposed by the app runtime.
3 properties
2 required
ProcessResourcesDefinition
object
1 property
ViewDisplayConfiguration
object
1 required
ViewResultField
object
4 properties
1 required
AppGitSourceConfig
object
7 properties
TaskField
object
6 properties
2 required
JSONObject
object
ViewExperienceConfiguration
object
8 properties
1 required
InteractionVisibility
string
ViewSelectionMode
string
InCodeTypeRef
object
4 properties
3 required
CatalogInteractionRef
object
Reference to an interaction in the catalog. Used in catalog listing. The id is composed of the namespace and the interaction name. Stored interactions can use…
9 properties
5 required
AppVersionState
string
EvaluationGateReason
string
Why a run was selected for LLM evaluation.
InCodeTypeDefinition
object
12 properties
2 required
MistralTextOptions
object
14 properties
OpenAiThinkingOptions
object
12 properties
AgentSearchScope
string
Defines the scope for agent search operations.
ColumnLayout
object
5 properties
2 required
ProcessAgentExecutionPolicy
object
11 properties
1 required
AppRepoTree
object
A non-recursive listing of an app git repo directory at a given ref.
3 properties
1 required
ViewSearchFieldDefinition
object
A mapped Elasticsearch field that a View may use for query planning and deterministic full-text fallback.
5 properties
1 required
DSLActivityOptions
object
The payload for a DSL activity options.
5 properties
ProcessDefinitionMetadata
object
RunKind
string
Internal discriminator key for documents stored in the agentruns collection.
RenderingTemplateDefinitionRef
object
8 properties
6 required
BedrockNovaOptions
object
9 properties
ViewElasticsearchQuery
object
An author-provided Elasticsearch query subtree validated by the View runtime.
ExchangeAppGithubAuthorizationResponse
object
3 properties
3 required
TextFallbackOptions
object
10 properties
AgentToolApprovalMode
string
AppGithubRepository
object
5 properties
5 required
AppGithubRepositorySetup
object
Branch choices and write-safety state for a verified GitHub repository.
3 properties
3 required
RunType
string
Public-facing runtime mode.
ViewGalleryDisplay
object
9 properties
5 required
BinaryFileResponse
string
BranchJoinPolicy
string
InferenceProfileId
string
MongoDB ObjectId of the inference profile.
AppApiKeyCollectionParams
object
ViewRangeDefinition
object
4 properties
2 required
AppVersionGitSource
object
10 properties
AppVersionUrls
object
5 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
UpsertAppVersionRequest
object
27 properties
3 required
ViewExperienceLayout
object
2 properties
ViewTableColumn
object
7 properties
1 required
ErrorResponse
object
Standard JSON error response returned by the server error handler.
5 properties
2 required
AppPackageHooks
object
Lifecycle and event hooks exposed by the app runtime. Lifecycle entries are informational; Studio invokes their conventional sibling endpoints directly.
3 properties
AgentRunnerOptions
object
Configuration options for Agent Runner functionality. These options control how interactions are exposed and executed in the Agent Runner.
11 properties
AgentRunSearchHit
object
A single search hit from Elasticsearch.
27 properties
8 required
OpenAiTextOptions
object
16 properties
ViewNavigationItem
object
1 required
ParallelCollectDefinition
object
3 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Vertesia 12
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 Audit Trail API
Vertesia Bulk Operations API
Vertesia Collections API
Vertesia Commands API
Vertesia Content Object Types API
Vertesia Content Query API
Vertesia Costs API
#Application
Where this information came from
This is an independent, third-party profile of Vertesia Apps 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.