Skip to main content
PATCH
/
agents
/
tasks
/
comments
/
{comment_id}
Update Task Comment
curl --request PATCH \
  --url https://api.example.com/agents/tasks/comments/{comment_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>"
}
'
{
  "organization_id": "<string>",
  "task_id": "<string>",
  "body": "<string>",
  "author_type": "user",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "author_user_id": "<string>",
  "author_instance_id": "<string>",
  "author_agent_type_id": "<string>",
  "edited": false
}

Path Parameters

​
comment_id
string
required

Body

application/json

Request body for editing a task comment.

Attributes: body: New markdown body to replace the existing one.

​
body
string
required

Response

Successful Response

A markdown comment on a task.

Comments are first-class graph nodes connected to tasks via has_comment edges. Authorship is recorded as graph edges as well: user comments use authored_by_user and agent comments persist a dual authored_by_instance plus authored_by_type pair so that type-level attribution survives instance garbage collection.

Attributes: id: SurrealDB record ID (populated by database). organization_id: Owning organization (mirrored from the task). task_id: Task this comment belongs to. body: Markdown body of the comment. author_type: Whether the author is a user or an agent. author_user_id: User ID when author_type is user. author_instance_id: Agent instance ID when author_type is agent. author_agent_type_id: Agent type ID when author_type is agent. edited: True after at least one update.

​
organization_id
string
required
​
task_id
string
required
​
body
string
required
​
author_type
enum<string>
required

Source of a task comment.

Available options:
user,
agent
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
id
string | null
​
author_user_id
string | null
​
author_instance_id
string | null
​
author_agent_type_id
string | null
​
edited
boolean
default:false