Get Index

beta.indexes.get(, ) -> IndexGetResponse

GET/api/v1/indexes/{index_id}

Get an index by ID.

ParametersExpand Collapse

index_id: str

organization_id: Optional[str]

project_id: Optional[str]

ReturnsExpand Collapse

class IndexGetResponse: …

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

Get Index

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
)
index = client.beta.indexes.get(
    index_id="index_id",
)
print(index.id)

{
  "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"
}

Returns Examples

{
  "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"
}