Describe vector index

Returns the configuration and state of one vector index, addressed by name or by index ID.

GET /v1/projects/{project_id}/vector-indexes/{index_name}

Inspect a project's index before useConfiguration describes the index; it does not contain its records.

Select the project indexAddress the index by its name or ID.
Read its configurationInspect dimensions, metric and state.
Prepare matching inputsUse vectors compatible with that configuration.

Before you start

Use your organization API key on the control-plane origin.

Connection setup

Use the project and index you intend to inspect or change.

Path parameters

Field	Type	Required
`project_id`	`string`	Required
`index_name`	`string`	Required

Read the result

Read state before using the index, and match new vectors to its dimension and metric. This returns configuration, not the records stored in the index.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
502	Check service availability and the write outcome.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "https://api.originchain.ai/v1/projects/your-project-id/vector-indexes/demo-index" \
  --header "Authorization: Bearer ${OC_ORG_API_KEY}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "index_id": "22222222-2222-4222-8222-222222222222",
  "name": "demo-search",
  "state": "active",
  "dimension": 3,
  "metric": "cosine",
  "score_direction": "higher_is_better",
  "sparse": false,
  "text_fields": [],
  "visibility_fields": [],
  "embedding": null,
  "deletion_protection": "disabled",
  "tags": {},
  "identifier_profile": "unicode",
  "compat_family": "vectors",
  "created_at": "2026-10-30T00:00:00.000Z",
  "project_id": "44444444-4444-4444-8444-444444444444"
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Read the result

Response statuses