Skip to content
Developer Documentation
API Reference
Beta
Indexes

List Indexes

beta.indexes.list(IndexListParams**kwargs) -> SyncPaginatedCursor[IndexListResponse]
GET/api/v1/indexes

List indexes for the current project.

ParametersExpand Collapse
organization_id: Optional[str]
page_size: Optional[int]
page_token: Optional[str]
project_id: Optional[str]
source_directory_id: Optional[str]
ReturnsExpand Collapse
class IndexListResponse: …

A searchable index over a directory of documents.

id: str

Unique identifier

export_config_id: str

ID of the export configuration.

name: str

Index name.

project_id: str

Project this index belongs to.

source_directory_id: str

ID of the source directory.

sync_config_id: str

ID of the sync configuration.

created_at: Optional[datetime]

Creation datetime

formatdate-time
description: Optional[str]

Index description.

last_exported_at: Optional[datetime]

Last export time.

formatdate-time
last_synced_at: Optional[datetime]

Last sync time.

formatdate-time
metadata: Optional[Dict[str, object]]

Build state and diagnostic info.

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Indexes

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
page = client.beta.indexes.list()
page = page.items[0]
print(page.id)
{
  "items": [
    {
      "id": "id",
      "export_config_id": "export_config_id",
      "name": "name",
      "project_id": "project_id",
      "source_directory_id": "source_directory_id",
      "sync_config_id": "sync_config_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "last_exported_at": "2019-12-27T18:11:19.117Z",
      "last_synced_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "export_config_id": "export_config_id",
      "name": "name",
      "project_id": "project_id",
      "source_directory_id": "source_directory_id",
      "sync_config_id": "sync_config_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "last_exported_at": "2019-12-27T18:11:19.117Z",
      "last_synced_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}