ApertureData Logo

API

  • API Description
  • Query protocol
  • Querying data
  • Transactions and references
  • Reading results
  • Schema
  • Descriptor classes and vector indexes
  • Responses
  • System-defined Properties
  • Handling of Missing Data
  • Access Control

Commands

  • AddEntity
  • AddBlob
  • AddImage
  • AddBoundingBox
  • AddPolygon
  • AddVideo
  • AddClip
  • AddDescriptor
  • AddConnection
  • AddFrame
  • FindEntity
  • FindBlob
  • FindImage
  • FindBoundingBox
  • FindPolygon
  • FindVideo
  • FindClip
  • FindDescriptor
  • FindDescriptorBatch
  • FindConnection
  • FindFrame
  • UpdateEntity
  • UpdateBlob
  • UpdateImage
  • UpdateBoundingBox
  • UpdatePolygon
  • UpdateVideo
  • UpdateClip
  • UpdateDescriptor
  • UpdateConnection
  • UpdateFrame
  • DeleteEntity
  • DeleteBlob
  • DeleteImage
  • DeleteBoundingBox
  • DeletePolygon
  • DeleteVideo
  • DeleteClip
  • DeleteDescriptor
  • DeleteConnection
  • DeleteFrame
  • ExtractFrames
  • ClassifyDescriptor
  • RegionIoU
  • GetMetrics
  • GetStatus
  • GetSchema
  • GetApiSchema
  • UserLogMessage
  • CreateIndex
  • GetIndexes
  • RemoveIndex
  • UpdateIndex
  • CreateAggregate
  • GetAggregates
  • RemoveAggregate
  • RenameClass
  • RemoveClass

Common Parameters

  • blobs
  • class
  • codec
  • connect
  • constraints
  • container
  • format
  • group_by_source
  • if_not_found
  • in_rectangle
  • is_connected_to
  • is_endpoint_of
  • key
  • label
  • with_label
  • limit
  • metric
  • Offset
  • operations
  • per_group
  • polygons
  • properties
  • rectangle
  • _ref and ref
  • remove_props
  • results
  • Text search expressions
  • sort
  • unique
  • uniqueids
  • url
  • Parameters for Positional Media Access

Access Control

  • Authenticate
  • GetUserDetails
  • CreateUser
  • UpdateUser
  • RemoveUser
  • CreateRole
  • UpdateRole
  • RemoveRole
  • GetUsers
  • GetRoles
  • GenerateToken
  • RefreshToken
  • Remote credentials
  • CreateCredential
  • GetCredentials
  • UpdateCredential
  • RemoveCredential

Administration

  • Resource planner
  • Deploying ApertureDB
  • Configuration File
  • Release Notes

Examples

  • Image Similarity Search
  • Query semantics and limitations
ApertureData
  • Search


© Copyright 2026, ApertureData Inc.

Built with Sphinx using a theme provided by Read the Docs.