For the complete documentation index, see llms.txt. This page is also available as Markdown.

List project comment threads

List project comment threads with the FLORA API: GET /projects/{projectId}/comment-threads.

Returns comment threads in the project, newest first within the matched set. Filter with status (open, resolved, or all), anchor (canvas, generation, or all), node_id (canvas node UUID or short id such as n7; unknown short ids are rejected), and query (plain-text match across live comments). Generation review threads include generation_id. Missing and inaccessible projects both return 404. Guests who can view or comment on the project can list threads; they do not need edit or generate permission.

GET https://app.flora.ai/api/v1/projects/{projectId}/comment-threads
  • Auth: API key as a bearer token, Authorization: Bearer $FLORA_API_KEY. See Authentication.

  • TypeScript SDK: client.projects.comments.list(), paginated. See Pagination.

  • Operation ID: listCommentThreads.

Example

curl -X GET 'https://app.flora.ai/api/v1/projects/prj_abc123/comment-threads' \
  -H "Authorization: Bearer $FLORA_API_KEY"
import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

// Paginated lists are async iterables; further pages are fetched as needed.
for await (const comment of await client.projects.comments.list({
  projectId: 'prj_abc123',
})) {
  console.log(comment);
}

Path parameters

Name
Type
Required
Description

projectId

string

Yes

Project identifier. Pattern: ^prj_\S+$. Example: prj_abc123.

Query parameters

Name
Type
Required
Description

limit

integer

No

Maximum number of results to return. 1 to 100.

cursor

string

No

Opaque cursor for fetching the next page. Example: eyJvZmZzZXQiOjIwfQ.

query

string

No

Search query. Example: logo.

status

string

No

Filter by thread status. Omit or all for every thread. One of: open, resolved, all.

node_id

string

No

Only threads pinned to this canvas node. At least 1 character. Example: n7.

anchor

string

No

Filter by pin location. Omit or all for every thread. One of: canvas, generation, all.

Responses

200: Comment threads returned.

Field
Type
Required
Description

comment_threads

array of objects

Yes

comment_threads[].comment_thread_id

string

Yes

Comment thread identifier. Pattern: ^cth_\S+$. Example: cth_abc123.

comment_threads[].project_id

string

Yes

Project identifier. Pattern: ^prj_\S+$. Example: prj_abc123.

comment_threads[].workspace_id

string

Yes

Workspace identifier. Pattern: ^ws_\S+$. Example: ws_abc123.

comment_threads[].status

string

Yes

Whether the thread is still open. One of: open, resolved.

comment_threads[].resolved_at

number or null

Yes

When the thread was resolved, as a Unix timestamp in milliseconds. Null while open.

comment_threads[].created_at

number

Yes

When the thread was created, as a Unix timestamp in milliseconds

comment_threads[].last_comment_at

number or null

Yes

When the latest live comment was created, as a Unix timestamp in milliseconds. Null when the thread has no live comments.

comment_threads[].comment_count

integer

Yes

Number of live comments in the thread. At least 0.

comment_threads[].anchor

string

Yes

Where the thread is pinned. canvas is a pin on the project canvas. generation is a review thread on a generation. One of: canvas, generation.

comment_threads[].generation_id

string

No

Public run id of the generation this review thread is pinned to. Absent on canvas threads. Pattern: ^run_\S+$. Example: run_abc123.

comment_threads[].position

object

Yes

comment_threads[].position.x

number

Yes

Canvas X coordinate of the pin

comment_threads[].position.y

number

Yes

Canvas Y coordinate of the pin

comment_threads[].position.node_id

string

No

Canvas node the pin is attached to, when pinned to a node

comment_threads[].preview

object or null

Yes

The first live comment in the thread. Null when the thread has no live comments.

comment_threads[].preview.comment_id

string

Yes

Comment identifier. Pattern: ^cmt_\S+$. Example: cmt_abc123.

comment_threads[].preview.body

string

Yes

Plain-text comment body. Example: Looks good — ship it..

comment_threads[].preview.author

object

Yes

comment_threads[].preview.author.type

string

Yes

Author kind. One of: user, anonymous, flora.

comment_threads[].preview.author.name

string

Yes

Display name. Example: Ada Lovelace.

comment_threads[].preview.author.profile_image_url

string (uri)

No

Author profile image URL

comment_threads[].preview.created_at

number

Yes

When the comment was created, as a Unix timestamp in milliseconds

meta

object

Yes

meta.next_cursor

string or null

Yes

Opaque cursor for fetching the next page. Example: eyJvZmZzZXQiOjIwfQ.

meta.total_estimate

integer or null

No

Estimated total matching items. At least 0.

Errors

Every error has the same body: error.code, error.message, and error.fields on validation errors. See Errors for how to recover from each code.

Status
Code
Meaning

400

invalid_json, input_validation_error

The body isn't valid JSON, or an input failed validation (fields lists each one).

401

unauthorized, invalid_api_key

The API key is missing, invalid or revoked.

402

insufficient_credits

The workspace balance is too low for this request.

403

forbidden, paid_plan_required

The key can't do this, or the workspace plan doesn't include it.

404

not_found

The resource doesn't exist or isn't visible to this key.

409

idempotency_duplicate, revision_conflict

Duplicate Idempotency-Key or a stale base_revision.

429

rate_limited

Too many requests. Back off and retry.

500

unknown_error, internal_error

Something failed on FLORA's side. Retry with backoff.

503

temporarily_unavailable

Authorization is temporarily unavailable. Retry later.

Last updated

Was this helpful?