List Projects

ProjectListPage projects().list(, )

GET/api/v2/projects

List projects in an organization. Requires organization_id or a project-scoped API key.

ParametersExpand Collapse

ProjectListParams params

Optional<String> name

Optional<String> organizationId

Optional<Long> pageSize

Optional<String> pageToken

ReturnsExpand Collapse

class Project:

API response schema for a project.

String id

The project’s unique identifier.

String name

The project’s display name.

String organizationId

The organization the project belongs to.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time

Optional<Boolean> isDefault

Whether this project is the default project for its organization.

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

List Projects

package ai.llamaindex.llamacloudadmin.example;

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.projects.ProjectListPage;
import ai.llamaindex.llamacloudadmin.models.projects.ProjectListParams;

public final class Main {
    private Main() {}

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

        ProjectListPage page = client.projects().list();
    }
}

{
  "items": [
    {
      "id": "id",
      "name": "name",
      "organization_id": "organization_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_default": true,
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "name": "name",
      "organization_id": "organization_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "is_default": true,
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}