# Get an AI Search index

Launch stage: Public Preview

`GET /api/2.0/ai-search/{name=workspaces/*/endpoints/*/indexes/*}`

Get details for a single AI Search index.

API scopes: ai-search

## Path parameters

- `name` (string, required)
  Full resource name of the index.
   Format: `workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}`

## Returns

Returns the Index object.

## Response

```json
{
  "name": "main.default.docs_index",
  "endpoint": "docs-endpoint",
  "primary_key": "string",
  "index_type": "string",
  "direct_access_index_spec": {
    "embedding_vector_columns": [
      {}
    ],
    "schema_json": "string",
    "embedding_source_columns": [
      {}
    ]
  },
  "delta_sync_index_spec": {
    "source_table": "string",
    "embedding_source_columns": [
      {}
    ],
    "embedding_vector_columns": [
      {}
    ],
    "embedding_writeback_table": "string",
    "columns_to_sync": [
      "string"
    ],
    "pipeline_id": "string",
    "pipeline_type": "string"
  },
  "status": {
    "message": "string",
    "indexed_row_count": 0,
    "ready": true,
    "index_url": "string"
  },
  "creator": "john@example.com",
  "index_subtype": "string"
}
```