API Reference

Beta

Indexes

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Index

client.Beta.Indexes.Get(ctx, indexID, query) (*BetaIndexGetResponse, error)

GET/api/v1/indexes/{index_id}

Get an index by ID.

ParametersExpand Collapse

indexID string

query BetaIndexGetParams

OrganizationID param.Field[string]optional

ProjectID param.Field[string]optional

ReturnsExpand Collapse

type BetaIndexGetResponse struct{…}

A searchable index over a directory of documents.

ID string

Unique identifier

ExportConfigID string

ID of the export configuration.

Name string

Index name.

OutputDirectoryID string

ID of the output directory holding the indexed files.

ProjectID string

Project this index belongs to.

SourceDirectoryID string

ID of the source directory.

SyncConfigID string

ID of the sync configuration.

CreatedAt Timeoptional

Creation datetime

formatdate-time

Description stringoptional

Index description.

LastExportedAt Timeoptional

Last export time.

formatdate-time

LastSyncedAt Timeoptional

Last sync time.

formatdate-time

Metadata map[string, any]optional

Build state and diagnostic info.

UpdatedAt Timeoptional

Update datetime

formatdate-time

Get Index

Go

HTTP

TypeScript

Python

Java

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llama-parse-go"
  "github.com/run-llama/llama-parse-go/option"
)

func main() {
  client := llamacloudprod.NewClient(
    option.WithAPIKey("My API Key"),
  )
  index, err := client.Beta.Indexes.Get(
    context.TODO(),
    "index_id",
    llamacloudprod.BetaIndexGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}