Skip to navigation
API ReferenceIndexes

Branch Index

Authentication

AuthorizationBearer

Use a tq_live_ API key as a Bearer token.

Path parameters

index_idstringRequired

Headers

x-talqora-organization-idstring or nullOptional

Request

This endpoint expects an object.
namestringRequiredformat: "^[a-z0-9][a-z0-9-.]*[a-z0-9]$"3-63 characters

Response

Successful Response
idstring
namestring
dimensionsinteger
distance_metricenum
Allowed values:
aws_regionstring
non_filterable_metadata_keyslist of strings
created_atdatetime
parent_index_idstring or nullOptional
branch_depthintegerOptionalDefaults to 0

Errors

422
Unprocessable Entity Error