Search documentation

Type to search.

Navigate · Enter to open · Esc to close

On this page

Create a documentation task. Supply a title and an optional body. New notes start with open status; the service assigns the identifier and creation timestamp.

POST /notes

Request body

Required. The title and optional details of the new task.

application/json

CreateNote

{
  "title": "Document the deployment workflow",
  "body": "Explain the build output and hosting configuration."
}

Responses

201

The note was created.

application/json

Note

{
  "id": "note-2",
  "title": "Document the deployment workflow",
  "body": "Explain the build output and hosting configuration.",
  "status": "open",
  "createdAt": "2026-10-04T10:05:00Z"
}

422

The request body failed validation.

application/json

Error

{
  "code": "validation_error",
  "message": "title must contain between 1 and 120 characters."
}

Request example

Replace the explicit placeholders with your API URL and values. Credentials are never populated automatically.

curl --request POST '<BASE_URL>/notes' \
  --header 'Content-Type: <MEDIA_TYPE>' \
  --data '<REQUEST_BODY>'