capsule

Check whether a read of this capsule may leave its Type's guidance out, and get fresh guidance checks

Changed on
post/api/preview/capsules/{id}/guidance-check

Request

  • Base URL
    https://symbol.chat (the document declares no server; this is the origin it was published from)
  • URL
    https://symbol.chat/api/preview/capsules/{id}/guidance-check
  • Auth
    • HTTP bearer
    • or API key in cookie __Secure-next-auth.session-token
    • or OAuth 2
      Authorization code: https://mcp.symbol.chat/authorize
      Token URL: https://mcp.symbol.chat/token

Path parameters

idstring required

UUID v4 string

Request body

checkstring

The guidance_check the model passed, as it was issued.

countinteger

How many fresh checks to return, 1 to 5. Default 1.

quotestring

The model's answer: the 5 words that follow the passage the check names.

Response

Successful response

guidancestring

The Type's current guidance, present when status is delivered.

reasonstring

Why the guidance is delivered, one of missing, malformed, expired, hold_expired, not_current, used, quote_missing, quote_mismatch, unavailable.

status'current' | 'delivered' | 'not_eligible' required

current: the guidance is unchanged and may be left out of this read. delivered: deliver guidance. not_eligible: this Type's guidance takes no checks; serve the read as it is.

Changes