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 Objects API

Content objects represent documents, files, images, and extracted data stored in Vertesia Content. Use these endpoints to search and retrieve content records for downstream processing and retrieval workflows.

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

This API exposes 29 operations across 25 paths, and defines 144 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.

29 operations 25 paths 144 schemas 2 DELETE13 GET11 POST3 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 Objects 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 29

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

Objects 29

Content objects represent documents, files, images, and extracted data stored in Vertesia Content. Use these endpoints to search and retrieve content records for downstream proces…

POST
/objects/upload-url
Create a content object upload URL
CreateObjectUploadUrl 1 param body → 2005004XX
POST
/objects/download-url
Create a content object download URL
CreateObjectDownloadUrl 1 param body → 2005004XX
POST
/objects/facets
Compute content object facets
ComputeObjectsFacets 1 param body → 2005004XX
POST
/objects/export/bulk
Start a content object export
StartContentObjectsExport 1 param body → 2005004XX
GET
/objects/export/bulk/artifacts
List content object exports
ListContentObjectExports 1 param → 2005004XX
DELETE
/objects/export/bulk/artifacts/{exportId}
Delete a content object export
DeleteContentObjectExport 2 params → 2005004XX
GET
/objects/export/bulk/artifacts/{exportId}/{role}/download-url
Create a content object export download URL
GetContentObjectExportDownloadUrl 3 params → 2005004XX
GET
/objects/export/bulk/{workflowId}/{runId}
Get content object export status
GetContentObjectsExportStatus 3 params → 2005004XX
POST
/objects
Create a content object
CreateObject 5 params body → 2005004XX
POST
/objects/search
Search content objects
SearchObjects 1 param body → 2005004XX
POST
/objects/count
Count content objects
CountObjects 1 param body → 2005004XX
POST
/objects/export
Export content object properties
ExportObjectProperties 1 param body → 2005004XX
GET
/objects/{objectId}
Retrieve a content object
GetObject 2 params → 2005004XX
PUT
/objects/{objectId}
Update a content object
UpdateObject 10 params body → 2005004XX
DELETE
/objects/{objectId}
Delete a content object
DeleteObject 2 params → 2005004XX
GET
/objects/{objectId}/text
Get content object text
GetObjectText 2 params → 2005004XX
PUT
/objects/{objectId}/text
Set content object text
SetObjectText 2 params body → 2005004XX
GET
/objects/{objectId}/content-source
Get content object source
GetObjectContentSource 2 params → 2005004XX
GET
/objects/{objectId}/renditions/{format}
Get a content object rendition
GetObjectRendition 7 params → 2002024225004XX
GET
/objects/{objectId}/workflow-runs
List content object workflow runs
ListObjectWorkflowRuns 2 params → 2005004XX
PUT
/objects/{objectId}/embeddings/{type}
Set content object embeddings
SetObjectEmbeddings 3 params body → 2005004XX
GET
/objects/{objectId}/embeddings/{type}
Get content object embeddings
GetObjectEmbeddings 3 params → 2005004XX
GET
/objects/{objectId}/revisions
List content object revisions
ListObjectRevisions 2 params → 2005004XX
GET
/objects/{objectId}/collections
List content object collections
ListObjectCollections 2 params → 2005004XX
POST
/objects/{objectId}/analyze
Start document prep
AnalyzeObjectDocument 2 params body → 2005004XX
GET
/objects/{objectId}/analyze/status
Get document prep status
GetObjectDocumentAnalysisStatus 2 params → 2005004XX
POST
/objects/{objectId}/analyze/grounded
Start grounded extraction
StartObjectDocumentGroundedExtraction 2 params body → 2005004XX
POST
/objects/{objectId}/analyze/grounded/assistant
Start the interactive grounded extraction assistant
StartObjectGroundedExtractionAssistant 2 params body → 2005004XX
GET
/objects/{objectId}/analyze/grounded/result
Get grounded extraction result
GetObjectDocumentGroundedExtractionResult 2 params → 2005004XX

Schemas 144

The contract defines 144 schemas that model the data the API accepts and returns. The most detailed are ContentObjectItemApiResponse (35 properties), ProjectedContentObjectApiResponse (35 properties), ContentObjectApiResponse (35 properties), UpdateContentObjectPayload (32 properties). Each schema is shown below with its type and property counts.

PromptStatus
string
PromptSegmentDefType
string
ContentObjectExportArtifact
object
7 properties 5 required
BedrockMistralOptions
object
8 properties
GroundedExtractionResultResponse
object
Completed grounded extraction result: the extracted data with its trust verdict and verification breakdown, plus a download URL for the full citations artifact.
8 properties 3 required
InteractionExecutionConfiguration
object
14 properties
ContentObjectExportResult
object
13 properties 9 required
Collection
object
24 properties 9 required
EmbeddingMap
object
OpenAiGptImageOptions
object
12 properties
ListWorkflowRunsResponse
object
3 properties 1 required
ContentObjectExportProgress
object
10 properties 3 required
RevisionInfo
object
4 properties 2 required
ModelOptions
object
FindPayload
object
6 properties 1 required
TwelvelabsPegasusOptions
object
4 properties
SortOrder
string
StartContentObjectExportResponse
object
3 properties 3 required
OpenAiTranscriptionOptions
object
2 properties
JSONValue
Embedding
object
3 properties 2 required
GetFileUrlPayload
object
3 properties 1 required
FacetSpec
object
2 properties 2 required
DocumentProcessingPhase
string
StringArrayMap
object
CollectionStatus
string
RunDataStorageLevel
string
PromptRole
string
BedrockMantleClaudeOptions
object
12 properties
VertexAIGeminiOptions
object
27 properties
VectorSearchQuery
object
5 properties
DocAnalyzerProgressStatus
object
4 properties 4 required
OpenAiImageGenerationOptions
object
12 properties 1 required
VertexAIClaudeOptions
object
12 properties
EmbeddingTypeEnabledMap
object
3 properties
SortOption
object
2 properties 1 required
ComplexSearchQuery
object
ComplexSearchQuery is used for full-text search and vector embedding search.
22 properties
SetObjectTextPayload
object
Payload for storing the extracted text of a content object as a text artifact.
2 properties 1 required
XAIGrokImageOptions
object
6 properties
ConversationVisibility
string
PromptSegmentRef_PromptTemplateRef
object
4 properties 2 required
VertexAIGeminiOmniVideoOptions
object
5 properties
StoredTypeRef
object
4 properties 3 required
SupportedEmbeddingTypes
string
BedrockGptOssOptions
object
9 properties
OpenAiAudioOptions
object
3 properties
BedrockPalmyraOptions
object
10 properties
ContentSource
object
4 properties
ContentObjectItemApiResponse
object
35 properties 10 required
DocumentPrepOptions
object
3 properties
GetFileUrlResponse
object
4 properties 3 required
dynamicScalingTypes
string
ProjectedContentObjectApiResponse
object
35 properties
ContentObjectItemApiResponseArray
array
BedrockConverseOptions
object
10 properties
VertexAIGrokOptions
object
5 properties
CountResult
object
1 property 1 required
DocAnalyzeRunStatusResponse
object
Represents a document analysis run status
6 properties 3 required
ComplexSearchPayload
object
10 properties
ContentObjectTextResponse
object
1 property
InteractionRef
object
13 properties 7 required
scoreAggregationTypes
string
CreateContentObjectPayload
object
When creating from an uploaded file the content should be an URL to the uploaded file
32 properties
BedrockAI21Options
object
9 properties
ListContentObjectExportsResponse
object
2 properties 2 required
GroqOptions
object
8 properties 1 required
TranscriptSegment
object
6 properties 2 required
InteractionStatus
string
BedrockCohereCommandOptions
object
10 properties
ObjectSearchResponse
object
3 properties 2 required
DocAnalyzerProgress
object
8 properties 5 required
WorkflowRun
object
21 properties 2 required
OpenAiImageGenerationMask
object
2 properties
AzureFoundryChatOptions
object
10 properties
SetObjectEmbeddingsResponse
object
1 property
BedrockMantleResponsesOptions
object
9 properties
ContentObjectUserPermissions
object
Computed per-request permissions for the current user on a content object. Not stored in the database — computed on the fly by the API from the object's securi…
2 properties 2 required
JSONObject
object
ExportPropertiesResponse
object
3 properties 3 required
BedrockMantleChatCompletionsOptions
object
8 properties
ThinkingLevel
string
GetRenditionResponse
object
3 properties 1 required
AgentCheckpointConfiguration
object
2 properties
OpenRouterTextOptions
object
23 properties
GenerationRunMetadata
object
5 properties 3 required
GroundedAssistantResponse
object
Response from starting the interactive grounded extraction assistant. The agent run + conversation workflow are launched server-side (recordRun - stage the doc…
3 properties 3 required
ReasoningEffort
string
InteractionVisibility
string
ComputeObjectFacetPayload
object
2 properties 1 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
OpenAiDalleOptions
object
6 properties
InCodeTypeRef
object
4 properties 3 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
GroundedVerificationBreakdown
object
How each extracted value was verified. Two kinds, both trustworthy: digitally verified (matched the document's text — digital layer or OCR) and AI verified (th…
4 properties 4 required
MistralTextOptions
object
14 properties
ConfigModes
string
ContentObjectExportArtifactFile
object
5 properties 5 required
OpenAiThinkingOptions
object
12 properties
AgentSearchScope
string
Defines the scope for agent search operations.
ContentObjectStatus
string
ColumnLayout
object
5 properties 2 required
OpenAiSpeechOptions
object
5 properties
GetUploadUrlPayload
object
4 properties 1 required
EmbeddingSearchConfig
ContentObjectProcessingPriority
string
AnthropicClaudeOptions
object
13 properties
ImagenTaskType
string
BedrockNovaOptions
object
9 properties
WorkflowExecutionStatus
number
ImagenMaskMode
string
DeleteContentObjectExportResponse
object
3 properties 3 required
NovaCanvasOptions
object
13 properties 1 required
ContentObjectApiRevision
object
4 properties 2 required
TextFallbackOptions
object
10 properties
InheritedPropertyMetadata
object
Metadata about a single inherited property.
2 properties 2 required
ContentObjectExportStatusResponse
object
7 properties 4 required
DeleteContentObjectResult
object
2 properties 2 required
CollectionArray
array
ImagenOptions
object
19 properties
StartContentObjectExportRequest
object
5 properties
InferenceProfileId
string
MongoDB ObjectId of the inference profile.
Record_SearchTypes_number
object
ComputedFacetResponse
object
1 property
Transcript
object
3 properties
ContentObjectApiResponse
object
35 properties 10 required
SkillContextTriggers
object
Context triggers for auto-injection of skills. When these conditions match, the skill is automatically injected into the agent context.
3 properties
UpdateContentObjectPayload
object
When creating from an uploaded file the content should be an URL to the uploaded file
32 properties
ExportContentObjectsIncludeOptions
object
Optional object context to include in content object export rows.
6 properties
ContentObjectApiTypeRef
ExportPropertiesPayload
object
4 properties 2 required
GroundedExtractionVerdict
string
Document-level trust verdict for a grounded extraction. goodtogo means the extracted content (after any review corrections) can be used without a human check;…
ErrorResponse
object
Standard JSON error response returned by the server error handler.
5 properties 2 required
AgentRunnerOptions
object
Configuration options for Agent Runner functionality. These options control how interactions are exposed and executed in the Agent Runner.
11 properties
ExportContentObjectsFilter
object
Bounded filters supported by the bulk content object export API.
5 properties
ContentObjectTypeRef
object
1 required
PromptTemplateRef
object
10 properties 7 required
GroundedExtractionRequest
object
Request body to start a grounded extraction on a content object. All fields are optional: with none set, the object's own content-type schema drives the extrac…
22 properties
ContentEmbeddingMap
object
3 properties
DocProcessorOutputFormat
string
Output format for document processing workflows
ConversationActivityState
string
OpenAiTextOptions
object
16 properties
PromptCacheMode
string
TemplateType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vertesiahq-objects-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 Objects 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.