List accessible workspaces

GET/workspaces

Returns the workspaces available to the authenticated public API key, including each workspace’s public ID, name, creation timestamp, and caller role.

ReturnsExpand Collapse

workspaces: array of object { created_at, name, role, workspace_id }

created_at: number

name: string

Workspace name

role: string

Workspace role

workspace_id: string

Workspace identifier

List accessible workspaces

curl https://app.flora.ai/api/v1/workspaces \
    -H "Authorization: Bearer $FLORA_API_KEY"

{
  "workspaces": [
    {
      "created_at": 0,
      "name": "Brand Studio",
      "role": "role",
      "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

{
  "workspaces": [
    {
      "created_at": 0,
      "name": "Brand Studio",
      "role": "role",
      "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."
  }
}