> For the complete documentation index, see [llms.txt](https://docs.flora.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flora.ai/api/reference/comments/createcommentthread.md).

# Create a canvas comment thread

Create a canvas comment thread with the FLORA API: POST /projects/{projectId}/comment-threads.

Pins a new comment thread on the project canvas at `x`/`y` and posts the first message. Optionally attach the pin to a canvas node with `node_id` (UUID or short id such as n7; unknown short ids are rejected) and `offset_x`/`offset_y`. `author` chooses whether the comment is attributed to the credential's user (`user`, the default) or to FLORA (`flora`). `author=flora` is reserved for Flora's own FAUNA, Chat, and Create agents; customer API keys and MCP credentials receive `forbidden`. Generation review threads cannot be created here. Guests who can comment on the project can create threads; they do not need edit or generate permission. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency\_duplicate.

```http
POST https://app.flora.ai/api/v1/projects/{projectId}/comment-threads
```

* **Auth:** API key as a bearer token, `Authorization: Bearer $FLORA_API_KEY`. See [Authentication](/api/platform/authentication.md).
* **TypeScript SDK:** `client.projects.comments.create()`.
* **Idempotency:** optional `Idempotency-Key` header. See [Idempotency](/api/platform/idempotency.md).
* **Operation ID:** `createCommentThread`.

## Example

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X POST 'https://app.flora.ai/api/v1/projects/prj_abc123/comment-threads' \
  -H "Authorization: Bearer $FLORA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "body": "<body>",
  "x": 1,
  "y": 1
}'
```

{% endtab %}

{% tab title="TypeScript SDK" %}

```typescript
import { FloraClient } from '@flora-ai/flora';

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

const comment = await client.projects.comments.create({
  projectId: 'prj_abc123',
  body: '<body>',
  x: 1,
  y: 1,
});
console.log(comment);
```

{% endtab %}
{% endtabs %}

## Path parameters

| Name        | Type   | Required | Description                                                      |
| ----------- | ------ | -------- | ---------------------------------------------------------------- |
| `projectId` | string | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`. |

## Request body

Required.

| Field      | Type   | Required | Description                                                                                                                                                                                                                                                                                           |
| ---------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `body`     | string | Yes      | Plain-text comment body. 1 to 10000 characters.                                                                                                                                                                                                                                                       |
| `x`        | number | Yes      | Canvas X coordinate of the pin                                                                                                                                                                                                                                                                        |
| `y`        | number | Yes      | Canvas Y coordinate of the pin                                                                                                                                                                                                                                                                        |
| `node_id`  | string | No       | Attach the pin to this canvas node. At least 1 character. Example: `n7`.                                                                                                                                                                                                                              |
| `offset_x` | number | No       | Horizontal offset from the node's origin when node\_id is set. Defaults to 0.                                                                                                                                                                                                                         |
| `offset_y` | number | No       | Vertical offset from the node's origin when node\_id is set. Defaults to 0.                                                                                                                                                                                                                           |
| `author`   | string | No       | Who the comment is attributed to. `user` posts as the credential's user. `flora` posts as FLORA, the product voice, and is accepted only from Flora's own FAUNA, Chat, and Create credentials. Customer API keys and MCP credentials cannot use `flora`. Defaults to `user`. One of: `user`, `flora`. |

## Responses

### 201: Comment thread created.

| Field                                 | Type             | Required | Description                                                                                                                                           |
| ------------------------------------- | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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](/api/platform/errors.md) 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.                              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flora.ai/api/reference/comments/createcommentthread.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.