Vertesia Projects API
Project endpoints manage project records, configuration, integrations, enabled plugins, and project-scoped app assets.
Vertesia Projects 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 Project. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.
This API exposes 23 operations across 17 paths, and defines 230 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.
23 operations
17 paths
230 schemas
1 DELETE16 GET2 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Vertesia Projects 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 23
Across 17 paths, the API surfaces 23 operations — 1 DELETE, 16 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Projects 23
Project endpoints manage project records, configuration, integrations, enabled plugins, and project-scoped app assets.
GET
/projects
List projects
POST
/projects
Create a project
GET
/projects/{projectId}
Retrieve a project
PUT
/projects/{projectId}
Update a project
DELETE
/projects/{projectId}
Delete a project
PUT
/projects/{projectId}/configuration
Update project configuration
GET
/projects/{projectId}/integrations/{integrationId}
Retrieve a project integration
PUT
/projects/{projectId}/integrations/{integrationId}
Update a project integration
GET
/projects/{projectId}/integrations
List project integrations
POST
/projects/{projectId}/plugins
Update project plugins
GET
/projects/{projectId}/plugins
List project plugins
GET
/projects/{projectId}/tools
List project tools
GET
/projects/{projectId}/tools/{toolName}
Retrieve a project tool
GET
/projects/{projectId}/app-types
List project app content types
GET
/projects/{projectId}/app-types/{typeId}
Retrieve a project app content type
GET
/projects/{projectId}/app-templates
List project app templates
GET
/projects/{projectId}/app-templates/{templateId}
Retrieve a project app template
GET
/projects/{projectId}/app-processes
List project app processes
GET
/projects/{projectId}/app-processes/{processId}
Retrieve a project app process
GET
/projects/{projectId}/app-views
List project app Views
GET
/projects/{projectId}/app-views/{viewId}
Retrieve a project app View
GET
/projects/{projectId}/composite-app
Retrieve composite app configuration
PUT
/projects/{projectId}/composite-app
Update composite app configuration
Schemas 230
The contract defines 230 schemas that model the data the API accepts and returns. The most detailed are NodeDefinition (38 properties), VertexAIGeminiOptions (27 properties), OpenRouterTextOptions (23 properties), ImagenOptions (19 properties). Each schema is shown below with its type and property counts.
ViewDropConfiguration
object
A declarative result-area drop target. Stored JSON supports the built-in upload action only.
3 properties
1 required
ViewLocationNavigation
object
9 properties
3 required
ModelDefault
object
Environment and model pair for a default configuration.
2 properties
2 required
ViewListDisplay
object
10 properties
4 required
ProcessScriptSource
BedrockMistralOptions
object
8 properties
SupportedIntegrations_serper
string
InteractionExecutionConfiguration
object
14 properties
ContentTypeExtractionGroundingReviewPolicy
object
5 properties
SystemDefaults
object
5 properties
DeleteByIdResult
object
1 property
1 required
OpenAiGptImageOptions
object
12 properties
ModelOptions
object
Project
object
14 properties
10 required
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
TwelvelabsPegasusOptions
object
4 properties
ProjectPluginArray
array
SupportedIntegrations_exa
string
ContentTypeExtractionGroundingPolicy
object
16 properties
ViewSearchConfiguration
object
6 properties
OpenAiTranscriptionOptions
object
2 properties
CompositeAppHeaderOverrides
object
Header button visibility overrides for the CompositeApp header.
3 properties
JSONValue
ViewRangeNavigation
object
9 properties
5 required
RunDataStorageLevel
string
ProcessAgentPhaseReset
object
3 properties
2 required
AgenticViewSearchConfiguration
object
7 properties
ProjectToolInfo
object
Information about a tool and its associated app installation. Used to look up which app provides a specific tool.
5 properties
3 required
BedrockMantleClaudeOptions
object
12 properties
VertexAIGeminiOptions
object
27 properties
ICreateProjectPayload
object
4 properties
2 required
ViewActionsConfiguration
object
3 properties
ProcessAgentToolInputContains
object
4 properties
2 required
ProjectIntegrationConfigResponse
object
1 required
ViewAgenticExecutionConfiguration
object
14 properties
OpenAiImageGenerationOptions
object
12 properties
1 required
ProjectSearchPropertyMappingMap
object
VertexAIClaudeOptions
object
12 properties
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…
EmbeddingTypeEnabledMap
object
3 properties
ProjectSearchPropertyMapping
object
Explicit search mapping for one content-object property. Changing a mapping requires a full reindex. Existing Elasticsearch fields cannot change type in place.
4 properties
1 required
SupportedIntegrations_magic_pdf
string
XAIGrokImageOptions
object
6 properties
ProjectModelDefaults
object
Extensible project defaults using map/dictionary pattern.
3 properties
BranchDefinition
object
4 properties
1 required
ProcessAgentToolPhase
object
8 properties
3 required
ElasticsearchBackend
string
VertexAIGeminiOmniVideoOptions
object
5 properties
BedrockGptOssOptions
object
9 properties
ViewSortOption
object
3 properties
3 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
OpenAiAudioOptions
object
3 properties
BedrockPalmyraOptions
object
10 properties
ProcessNodeType
string
ProcessNodeReturnsDefinition
object
2 properties
ProjectToolInfoArray
array
ViewBoardCardConfiguration
object
5 properties
1 required
ProjectPluginsUpdatePayload
object
1 property
1 required
CompositeAppMessageStyle
string
Message banner overrides for the shell header.
SupportedIntegrations_aws
string
JSONSchemaProperties
object
InCodeProcessDefinition
object
6 properties
3 required
StringValueMap
object
BedrockConverseOptions
object
10 properties
VertexAIGrokOptions
object
5 properties
CountResult
object
1 property
1 required
GithubConfiguration
object
5 properties
3 required
AskUserWebhookConfigurationInput
object
Configuration for askuser webhook notifications. Sends webhooks when agents call askuser and when users respond.
6 properties
3 required
ContentTypeEditingPolicy
object
Per-content-type policy for collaborative document editing.
1 property
ProjectSearchPropertyType
string
Elasticsearch field types that may be explicitly assigned to content-object properties. Declare nested object-array paths with type nested and their children a…
LinkupConfiguration
object
5 properties
3 required
MagicPdfConfiguration
object
4 properties
2 required
ViewBoardDisplay
object
8 properties
5 required
ProjectInferenceProfiles
object
Project defaults reference profile MongoDB IDs. Profile definitions are managed through the inference profiles API.
3 properties
UpdateProjectPayload
object
12 properties
CompositeAppNavItemPermissions
object
Access control settings for a composite app nav item. If any of groupsAllowed, usersAllowed, or rolesAllowed are set, access is granted when the user matches A…
3 properties
LinkupConfigurationInput
object
3 properties
2 required
NodeDefinition
object
38 properties
1 required
InCodeViewDefinitionArray
array
BranchNodeBranchDefinition
object
5 properties
2 required
JSONSchema
object
9 properties
CompositeAppCardOverrides
object
Card display overrides for the CompositeApp in the App Portal. Similar to AppManifest display properties, but specific to the CompositeApp card. Allows custome…
5 properties
CompositeAppHeaderItemKind
string
Discriminator for a header item. The four built-ins (appportal, docs, help, usermenu) seed the default header and cannot be deleted (only hidden/customized); c…
ViewSearchFieldType
string
CompositeAppConfigPayload
object
13 properties
ProjectIntegrationConfigRequest
object
1 required
SerperConfigurationInput
object
4 properties
2 required
GladiaConfigurationInput
object
4 properties
2 required
IntakeVisionProfileSettingsUpdate
object
4 properties
ResendConfiguration
object
13 properties
5 required
BedrockAI21Options
object
9 properties
SupportedIntegrations_github
string
CompositeAppMenuNavItem
object
A navigable item in the sidebar menu. An "app" is just a nav-item with appName + route: "/" that has children. Nav-items carry their own appName for routing, i…
10 properties
2 required
ProcessDefinitionBody
object
9 properties
5 required
AwsConfiguration
object
3 properties
2 required
ModalityDefaults
object
Modality-specific default model overrides. These override the base default when specific input modalities are detected.
2 properties
GroqOptions
object
8 properties
1 required
InCodeTypeDefinitionArray
array
ProjectRefArray
array
UpdateProjectConfigurationPayload
object
18 properties
CompositeAppEntry
object
Configuration entry for an individual app in the CompositeApp shell. References an app installation by name.
1 property
1 required
SupportedIntegrations_gladia
string
ViewSortClause
object
2 properties
2 required
RenderingTemplateDefinitionRefArray
array
InCodeViewDefinition
object
A View definition contributed by application code through the app package endpoint.
6 properties
3 required
BedrockCohereCommandOptions
object
10 properties
ViewCardsDisplay
object
11 properties
4 required
ProjectIntakeConfiguration
object
9 properties
ProcessResourcesDefinition
object
1 property
ViewDisplayConfiguration
object
1 required
TransitionDefinition
object
5 properties
1 required
RenderingTemplateDefinition
object
8 properties
6 required
OpenAiImageGenerationMask
object
2 properties
ParallelCollectField
string
ParallelCollectMode
string
ViewResultField
object
4 properties
1 required
ParallelCollectDefinition
object
3 properties
1 required
CompositeAppHomePlugin
object
2 properties
1 required
AzureFoundryChatOptions
object
10 properties
CompositeAppUserMenuOverrides
object
User menu overrides for the CompositeApp.
1 property
TaskField
object
6 properties
2 required
ProcessScriptResourceMap
object
BedrockMantleResponsesOptions
object
9 properties
ContentObjectTypeStatus
string
SupportedIntegrations_resend
string
ProjectIntegrationListEntry
object
2 properties
2 required
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
SupportedIntegrations
string
ViewHierarchyLevel
object
5 properties
3 required
AgentProjectConfiguration
object
Agent runtime configuration, scoped under project configuration so agent settings have one home (configuration.agent).
3 properties
BedrockMantleChatCompletionsOptions
object
8 properties
JSONObject
object
ViewTableDisplay
object
6 properties
4 required
ViewResultsConfiguration
object
8 properties
2 required
ViewBoardColumn
object
3 properties
2 required
ThinkingLevel
string
ProjectRef
object
4 properties
3 required
AgentCheckpointConfiguration
object
2 properties
ViewExperienceConfiguration
object
8 properties
1 required
OpenRouterTextOptions
object
23 properties
HumanTaskDefinition
object
4 properties
2 required
ReasoningEffort
string
ViewSelectionMode
string
CompositeAppThemeOverrides
object
Theme overrides for the CompositeApp.
1 property
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
ProjectConfigurationEmbedding
object
5 properties
1 required
OpenAiDalleOptions
object
6 properties
ViewResultFieldFormat
string
ResendConfigurationInput
object
9 properties
3 required
ExaConfigurationInput
object
3 properties
2 required
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
BedrockClaudeOptions
object
13 properties
ViewKeyTermDefinition
object
6 properties
3 required
InCodeProcessDefinitionArray
array
InCodeTypeDefinition
object
12 properties
2 required
ConfigModes
string
MistralTextOptions
object
14 properties
OpenAiThinkingOptions
object
12 properties
SerperConfiguration
object
6 properties
3 required
ProcessDefinitionFormatVersion
number
GithubConfigurationInput
object
5 properties
2 required
ColumnLayout
object
5 properties
2 required
OpenAiSpeechOptions
object
5 properties
BrowserUseScreenshotCapture
string
CompositeAppMenuSection
object
A top-level section heading in the sidebar menu. Sections are always at root level and contain nav-items.
4 properties
3 required
ProcessAgentExecutionPolicy
object
11 properties
1 required
IntakeVisionProfileSettingsMap
object
3 properties
ViewSearchFieldDefinition
object
A mapped Elasticsearch field that a View may use for query planning and deterministic full-text fallback.
5 properties
1 required
ProcessDefinitionMetadata
object
CompositeAppMessageOverrides
object
3 properties
CompositeAppSwitchersOverrides
object
Switcher visibility overrides for the CompositeApp header.
2 properties
CompositeAppSidebarOverrides
object
Sidebar display overrides for the CompositeApp.
4 properties
RenderingTemplateDefinitionRef
object
8 properties
6 required
AnthropicClaudeOptions
object
13 properties
GladiaConfiguration
object
6 properties
3 required
ImagenTaskType
string
BedrockNovaOptions
object
9 properties
ViewTermsNavigation
object
10 properties
4 required
ViewElasticsearchQuery
object
An author-provided Elasticsearch query subtree validated by the View runtime.
ImagenMaskMode
string
NodeDefinitionMap
object
TaskFieldType
string
AskUserWebhookConfiguration
object
Configuration for askuser webhook notifications. Sends webhooks when agents call askuser and when users respond.
8 properties
3 required
NovaCanvasOptions
object
13 properties
1 required
ProcessScriptLanguage
string
CompositeAppConfig
object
CompositeApp shell configuration. This is the main configuration interface for storing CompositeApp settings. Used as the MongoDB model for persisting Composit…
15 properties
3 required
TextFallbackOptions
object
10 properties
ProcessScriptResource
object
4 properties
3 required
ViewUploadDropParameters
object
5 properties
ViewGalleryDisplay
object
9 properties
5 required
ImagenOptions
object
19 properties
BranchJoinPolicy
string
InferenceProfileId
string
MongoDB ObjectId of the inference profile.
ResourceVisibility
string
CompositeAppLogoOverrides
object
Logo overrides for the CompositeApp shell header. When provided, these URLs replace the default Vertesia logo.
3 properties
JsonLogicRule
object
ViewAgenticSearchMode
string
ContentTypeIntakePolicy
object
Per-content-type policy for the standard intake workflows.
9 properties
TransitionTrigger
string
ViewRangeDefinition
object
4 properties
2 required
ProjectIntegrationListResponse
object
1 property
1 required
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…
ViewCollectionNavigation
object
9 properties
3 required
ViewResultMedia
object
4 properties
1 required
AgenticViewRerankConfiguration
object
4 properties
ViewSelectionConfiguration
object
Client-side selection behavior for normalized View hits.
2 properties
1 required
ProjectIndexingConfiguration
object
4 properties
ViewExperienceLayout
object
2 properties
ViewTableColumn
object
7 properties
1 required
ProcessContextDefinition
object
2 properties
2 required
CompositeAppHeaderItem
object
A single button in the CompositeApp header bar. Unlike sidebar nav-items, header items are free-form and not tied to an installed app: each is a labelled, icon…
8 properties
3 required
ProjectConfiguration
object
18 properties
1 required
ErrorResponse
object
Standard JSON error response returned by the server error handler.
5 properties
2 required
CompositeAppHeaderItemTarget
string
Where a header link opens.
ViewActionSelectionRequirement
string
SupportedIntegrations_ask_user_webhook
string
ParallelFailurePolicy
string
ViewActionPlacement
string
SupportedIntegrations_linkup
string
OpenAiTextOptions
object
16 properties
ViewNavigationItem
object
1 required
PromptCacheMode
string
BrowserUseRiskPolicy
string
ProjectSearchTier
string
ExaConfiguration
object
5 properties
3 required
ViewExperienceScope
object
6 properties
BrowserUseProjectConfiguration
object
8 properties
ProjectIntakeSniffConfiguration
object
Fast pre-conversion type identification (the "sniff") for untyped documents. The sniff classifies a document from cheap local evidence (first/last page text, a…
4 properties
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 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
#Project
Where this information came from
This is an independent, third-party profile of Vertesia Projects 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.