Update run notes

Updates the notes/description on a run. Set to null or empty string to clear.

POST /api/runs/notes/update

Update run notes

cURL

curl --request POST \
  --url https://pluto-api.trainy.ai/api/runs/notes/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "runId": 123,
  "notes": "<string>"
}
'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

API key obtained from the mlop dashboard

Body

application/json

runId · number · required

Numeric ID of the run

notes · string | null · required

Notes/description for the run (max 1000 chars). Set to null or empty string to clear.

Maximum string length: 1000

Response

200

application/json

Notes updated successfully

success · boolean · required