Notes

A note is free-text commentary (with optional attachments) attached to a parent entity. Notes let your team record context against the things they review.

Parent scoping

Every note is scoped to a parent by a pair of fields — entityType and entityId. The parent is one of:

entityType	Parent
APPLICATION	An application
SCREENING_HIT	A screening hit
DOCUMENT	A document
WORKFLOW_VERSION	A workflow version

GET /notes lists the notes for a given parent, and POST /notes creates one under a parent. You must have access to the parent entity to read or write its notes.

Operations

Operation	Endpoint	Notes
Create	POST /notes	Under a parent (entityType + entityId)
List	GET /notes	Scoped to a parent
Update	PATCH /notes/{noteId}	Edits content and attachments only
Delete	DELETE /notes/{noteId}	Soft delete

Notes have no type or category of their own — the parent entityType is the only classifier.

Example

# Add a note to an application
curl -X POST https://api.getsteward.ai/api/v1/notes \
  -H "Authorization: Bearer stw_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "entityType": "APPLICATION", "entityId": "{applicationId}", "content": "Verified against the registry." }'

# List a parent entity's notes
curl "https://api.getsteward.ai/api/v1/notes?entityType=APPLICATION&entityId={applicationId}" \
  -H "Authorization: Bearer stw_live_your_api_key_here"

Environment: Examples use Production (https://api.getsteward.ai) with an stw_live_… key. For Sandbox, use https://api.steward-sandbox.com with an stw_test_… key.