> ## Documentation Index
> Fetch the complete documentation index at: https://help.statisfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Comment on a project

> Adds a comment by the person who created the API key, who must be a current member of the workspace. The author and the people it mentions follow the project (they become its watchers) from then on; as in the app, no email is sent. Send an Idempotency-Key to retry safely.



## OpenAPI

````yaml /api/statisfy-api.openapi.json post /v1/objects/project/records/{project_id}/comments
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/objects/project/records/{project_id}/comments:
    post:
      tags:
        - comments
      summary: Comment on a project
      description: >-
        Adds a comment by the person who created the API key, who must be a
        current member of the workspace. The author and the people it mentions
        follow the project (they become its watchers) from then on; as in the
        app, no email is sent. Send an Idempotency-Key to retry safely.
      operationId: comments_add_project
      parameters:
        - in: path
          name: project_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                value:
                  description: >-
                    The comment's text, up to 10,000 characters. Mention a
                    person with the app's markup, [@Name](user:<person id>): a
                    user's id, or a contact's
                  maxLength: 10000
                  minLength: 1
                  title: Value
                  type: string
                visibility:
                  default: internal
                  description: >-
                    internal (your team only, the default) or external (also
                    shown in the customer's portal)
                  enum:
                    - internal
                    - external
                  title: Visibility
                  type: string
              required:
                - value
              type: object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Comment'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    Comment:
      properties:
        author:
          anyOf:
            - type: string
            - type: 'null'
          description: The author's person id
          title: Author
        author_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Author Name
        author_type:
          anyOf:
            - enum:
                - user
                - stella
                - workflow
              type: string
            - type: 'null'
          description: user (a person), stella (Statisfy AI) or workflow (an automation)
          title: Author Type
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Created At
        id:
          title: Id
          type: string
        mentions:
          description: The ids of the people the text mentions, in order, each once
          items:
            type: string
          title: Mentions
          type: array
        project:
          anyOf:
            - type: string
            - type: 'null'
          description: The id of the project the comment is on; null on a task comment
          title: Project
        synced:
          description: >-
            True when the comment came from a tool synced with the task, such as
            Jira
          title: Synced
          type: boolean
        task:
          anyOf:
            - type: string
            - type: 'null'
          description: The id of the task the comment is on; null on a project comment
          title: Task
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Updated At
        value:
          description: The text, with its mentions as [@Name](user:<person id>)
          title: Value
          type: string
        visibility:
          description: >-
            internal (your team only, the default) or external (also shown in
            the customer's portal)
          enum:
            - internal
            - external
          title: Visibility
          type: string
      required:
        - id
        - task
        - project
        - value
        - mentions
        - visibility
        - author
        - author_name
        - author_type
        - synced
        - created_at
        - updated_at
      title: Comment
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.