Notes

Create Note

Changed on

Create a new note attached to a registry resource.

post/notes

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /notes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Request body

bodystring required

Text of the note, up to 4000 characters.

confidence'observed' | 'suspected' | 'verified'

Author-supplied confidence in a note (matches the spec NoteConfidence enum).

related_execution_idstring nullable

ID of an execution the note relates to; null if none.

source'agent' | 'human' | 'platform'

Origin tag for a note (matches the spec NoteSource enum).

type'auth_quirk' | 'usage_hint' | 'execution_feedback' | 'correction'

Category of a note (matches the spec NoteType enum).

Example request

{
  "body": "Stripe returns 401 unless the secret key is sent as a Bearer token; Basic auth with an empty password also works.",
  "confidence": "observed",
  "related_execution_id": "exec_6968b3982706c619fe73f0cf",
  "resource": {
    "api": {
      "name": "stripe",
      "vendor": "stripe.com",
      "version": "2024-04-10"
    },
    "credential_id": "cred_6968b39855d91a3561684b32",
    "execution_id": "exec_6968b3982706c619fe73f0cf",
    "operation_id": "op_f92d69f1621f381bce8aaff47053c61b069ffe34"
  },
  "source": "agent",
  "type": "auth_quirk"
}

Response

Successful Response

unknown required

Changes

  • c516481e6ed8Revision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

  • d65fcba0d25aRevision changes
    • breaking

      added the new required request property

    • breaking

      removed subschema #1 from the request property anyOf list

    • breaking

      removed subschema #1 from the request property anyOf list

    • breaking

      removed subschema #1 from the request property anyOf list

    • breaking

      the request property type changed from string to object

    • breaking

      the response's property type changed from array to string for status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id create_note_notes_post removed and replaced with createNote

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security AgentOauthAccessToken was removed from the API

    • info

      the endpoint scheme security HumanLogin was removed from the API

    • info

      the endpoint scheme security JenticApiKey was removed from the API

    • info

      api tag Notes added

    • info

      api tag catalog removed

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added to the request property anyOf list

    • info

      added to the request property anyOf list

    • info

      added to the request property anyOf list

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status