Update a note | Ara Documentation

Partial update. Send only the fields you want to change.

_{Scope: run}

Authentication

AuthorizationBearer

Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, plugins:read, secrets:read, secrets:write, sessions:read, knowledge:read, repos:read, repos:write, reviews:read, reviews:write, analytics:read, org:read, org:write, attachments:read, attachments:write, plugins:write, guardrails:read, guardrails:write.

Path parameters

orgIdstringRequired

Organization id or slug. Resolve it with GET /v3/self.

noteIdstringRequired

Request

This endpoint expects an object.

namestringOptional

triggerstringOptional

bodystringOptional

scopestringOptional

repo_filterstringOptional

Response

Updated.

note_idstring

namestring

triggerstring

When the agent should consult this note.

bodystring

scopestring or null

repo_filterstring or null

created_atdatetime

updated_atdatetime

Errors

404

Not Found Error

$	curl -X PUT https://api.ara.so/v3/organizations/orgId/knowledge/notes/noteId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"note_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"name": "Deployment Instructions",
4	"trigger": "on_deploy",
5	"body": "Ensure all environment variables are set before deployment.",
6	"scope": "production",
7	"repo_filter": "repo:my-org/my-repo",
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z"
10	}