catalog

Add a note — annotate a capability with feedback or a correction

Attaches a note to any capability (operation, workflow, or API). Use to report auth corrections, schema errors, or updated Arazzo workflows. Notes feed back into the catalog improvement loop.

post/notes

Request body

resourcestring required

Resource identifier: operation_id (METHOD/host/path), api_id, or workflow slug

typestring nullable

Note category: 'auth_quirk', 'usage_hint', 'execution_feedback', or 'correction'

notestring required

Note content — be specific and actionable

execution_idstring nullable

Link to specific execution for context (optional)

confidencestring nullable

Confidence level: 'observed', 'suspected', or 'verified'

sourcestring nullable

Observation source, e.g. 'test run', 'production', 'documentation'

Response

Successful Response

{"stackTrail":"paths:/notes:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes