List workspace projects

client.projects.list(, ?): ProjectsCursorPage<ProjectListResponse { created_at, last_modified, name, 3 more } >

GET/projects

Returns projects in the requested workspace that are accessible to the authenticated public API key, ordered by recent activity.

ParametersExpand Collapse

query: ProjectListParams { workspace_id, cursor, limit, query }

workspace_id: string

Workspace identifier

cursor?: string

Opaque cursor for fetching the next page

limit?: number

Maximum number of results to return

minimum1

maximum100

query?: string

Search query

ReturnsExpand Collapse

ProjectListResponse { created_at, last_modified, name, 3 more }

created_at: number

last_modified: number | null

name: string

Project name

origin: string | null

Project origin

project_id: string

Project identifier

workspace_id: string

Workspace identifier

List workspace projects

import Flora from '@flora-ai/flora';

const client = new Flora({
  apiKey: process.env['FLORA_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const projectListResponse of client.projects.list({ workspace_id: 'ws_abc123' })) {
  console.log(projectListResponse.project_id);
}

{
  "meta": {
    "next_cursor": "eyJvZmZzZXQiOjIwfQ",
    "total_estimate": 0
  },
  "projects": [
    {
      "created_at": 0,
      "last_modified": 0,
      "name": "Spring Campaign",
      "origin": "api",
      "project_id": "prj_abc123",
      "workspace_id": "ws_abc123"
    }
  ]
}

{
  "error": {
    "code": "input_validation_error",
    "message": "prompt: Required",
    "fields": [
      {
        "field": "prompt",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "insufficient_credits",
    "message": "Insufficient credits."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found."
  }
}

{
  "error": {
    "code": "idempotency_duplicate",
    "message": "Duplicate idempotency key."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded."
  }
}

{
  "error": {
    "code": "unknown_error",
    "message": "An unknown error occurred."
  }
}

Returns Examples

{
  "meta": {
    "next_cursor": "eyJvZmZzZXQiOjIwfQ",
    "total_estimate": 0
  },
  "projects": [
    {
      "created_at": 0,
      "last_modified": 0,
      "name": "Spring Campaign",
      "origin": "api",
      "project_id": "prj_abc123",
      "workspace_id": "ws_abc123"
    }
  ]
}

{
  "error": {
    "code": "input_validation_error",
    "message": "prompt: Required",
    "fields": [
      {
        "field": "prompt",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "insufficient_credits",
    "message": "Insufficient credits."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found."
  }
}

{
  "error": {
    "code": "idempotency_duplicate",
    "message": "Duplicate idempotency key."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded."
  }
}

{
  "error": {
    "code": "unknown_error",
    "message": "An unknown error occurred."
  }
}