API Reference

Beta

Indexes

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Index

IndexGetResponse beta().indexes().get(IndexGetParamsparams = IndexGetParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/indexes/{index_id}

Get an index by ID.

ParametersExpand Collapse

IndexGetParams params

Optional<String> indexId

Optional<String> organizationId

Optional<String> projectId

ReturnsExpand Collapse

class IndexGetResponse:

A searchable index over a directory of documents.

String id

Unique identifier

String exportConfigId

ID of the export configuration.

String name

Index name.

String outputDirectoryId

ID of the output directory holding the indexed files.

String projectId

Project this index belongs to.

String sourceDirectoryId

ID of the source directory.

String syncConfigId

ID of the sync configuration.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<String> description

Index description.

Optional<LocalDateTime> lastExportedAt

Last export time.

formatdate-time

Optional<LocalDateTime> lastSyncedAt

Last sync time.

formatdate-time

Optional<Metadata> metadata

Build state and diagnostic info.

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

Get Index

Java

HTTP

TypeScript

Python

Java

Go

CLI Tool

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.beta.indexes.IndexGetParams;
import com.llamacloud_prod.api.models.beta.indexes.IndexGetResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        IndexGetResponse index = client.beta().indexes().get("index_id");
    }
}

200 example

{
  "id": "id",
  "export_config_id": "export_config_id",
  "name": "name",
  "output_directory_id": "output_directory_id",
  "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

200 example

{
  "id": "id",
  "export_config_id": "export_config_id",
  "name": "name",
  "output_directory_id": "output_directory_id",
  "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"
}