Get a comment thread
Get a comment thread with the FLORA API: GET /projects/{projectId}/comment-threads/{threadId}.
Returns one comment thread and its live messages, oldest first. Missing threads, threads in another project, and inaccessible projects all return 404.
GET https://app.flora.ai/api/v1/projects/{projectId}/comment-threads/{threadId}Auth: API key as a bearer token,
Authorization: Bearer $FLORA_API_KEY. See Authentication.TypeScript SDK:
client.projects.comments.retrieve().Operation ID:
getCommentThread.
Example
curl -X GET 'https://app.flora.ai/api/v1/projects/prj_abc123/comment-threads/cth_abc123' \
-H "Authorization: Bearer $FLORA_API_KEY"import { FloraClient } from '@flora-ai/flora';
const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });
const comment = await client.projects.comments.retrieve({
projectId: 'prj_abc123',
threadId: 'cth_abc123',
});
console.log(comment);Path parameters
projectId
string
Yes
Project identifier. Pattern: ^prj_\S+$. Example: prj_abc123.
threadId
string
Yes
Comment thread identifier. Pattern: ^cth_\S+$. Example: cth_abc123.
Responses
200: Comment thread returned.
comment_thread_id
string
Yes
Comment thread identifier. Pattern: ^cth_\S+$. Example: cth_abc123.
project_id
string
Yes
Project identifier. Pattern: ^prj_\S+$. Example: prj_abc123.
workspace_id
string
Yes
Workspace identifier. Pattern: ^ws_\S+$. Example: ws_abc123.
status
string
Yes
Whether the thread is still open. One of: open, resolved.
resolved_at
number or null
Yes
When the thread was resolved, as a Unix timestamp in milliseconds. Null while open.
created_at
number
Yes
When the thread was created, as a Unix timestamp in milliseconds
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_count
integer
Yes
Number of live comments in the thread. At least 0.
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.
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.
position
object
Yes
position.x
number
Yes
Canvas X coordinate of the pin
position.y
number
Yes
Canvas Y coordinate of the pin
position.node_id
string
No
Canvas node the pin is attached to, when pinned to a node
preview
object or null
Yes
The first live comment in the thread. Null when the thread has no live comments.
preview.comment_id
string
Yes
Comment identifier. Pattern: ^cmt_\S+$. Example: cmt_abc123.
preview.body
string
Yes
Plain-text comment body. Example: Looks good — ship it..
preview.author
object
Yes
preview.author.type
string
Yes
Author kind. One of: user, anonymous, flora.
preview.author.name
string
Yes
Display name. Example: Ada Lovelace.
preview.author.profile_image_url
string (uri)
No
Author profile image URL
preview.created_at
number
Yes
When the comment was created, as a Unix timestamp in milliseconds
messages
array of objects
Yes
Live comments in the thread, oldest first
messages[].comment_id
string
Yes
Comment identifier. Pattern: ^cmt_\S+$. Example: cmt_abc123.
messages[].body
string
Yes
Plain-text comment body. Example: Looks good — ship it..
messages[].author
object
Yes
messages[].author.type
string
Yes
Author kind. One of: user, anonymous, flora.
messages[].author.name
string
Yes
Display name. Example: Ada Lovelace.
messages[].author.profile_image_url
string (uri)
No
Author profile image URL
messages[].created_at
number
Yes
When the comment was created, as a Unix timestamp in milliseconds
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.
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?