---
title: "Get Index"
method: GET
path: "/api/v1/indexes/{index_id}"
tags: ["Indexes"]
---

# Get Index

`GET /api/v1/indexes/{index_id}`

Get an index by ID.

## Path parameters

- `index_id` string, required

## Query parameters

- `project_id` string, uuid, nullable
- `organization_id` string, uuid, nullable

## Cookies

- `session` string, nullable

## Response `200`

Successful Response

- IndexResponse — A searchable index over a directory of documents.
  - `id` union, required — Unique identifier
    - string
    - string, uuid
  - `created_at` string, date-time, nullable — Creation datetime
  - `updated_at` string, date-time, nullable — Update datetime
  - `name` string, required — Index name.
  - `description` string, nullable — Index description.
  - `project_id` string, required — Project this index belongs to.
  - `source_directory_id` string, required — ID of the source directory.
  - `sync_config_id` string, required — ID of the sync configuration.
  - `export_config_id` string, required — ID of the export configuration.
  - `last_synced_at` string, date-time, nullable — Last sync time.
  - `last_exported_at` string, date-time, nullable — Last export time.
  - `metadata` IndexMetadata — Build state and diagnostic info about an index. Schema is open; only `status` of `ready` or `failed` is stable.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/run-llama/apis/llama-platform.md) · [All operations](https://skmtc.net/run-llama/apis/llama-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/run-llama/llama-platform/versions/b17341164de9/schema)