DocsAPI reference

Forget

Deletes the evidence and every staged value for this slug.

delete/api/agents/{agent_id}/discovered-fields/{field_id}
Authentication
Bearer token
Retries
Idempotency-Key
Body
None
Version
2026-09-03

Distinct from dismissing, and both are needed. Dismiss says "not a field" - the observations stay on the contacts who volunteered them, and the slug is never offered again. Forget says "stop holding this", and clears the values out of every contact record too.

A tenant who realises their agent has been noting something they should not hold needs the second one, and needs it to actually remove the data rather than hide the suggestion.

Path parameters#

  • agent_idstring (uuid)required
  • field_idstring (uuid)required

Headers#

  • Idempotency-Keystring

    A unique key of your choosing, so this request can be retried safely. The first request with a given key executes; every replay returns that first response unchanged, with Idempotent-Replay: true set.

    Generate one key per action, not per session - reusing a key with a different body is refused with 422 rather than silently replaying the wrong answer. Keys are remembered for 24 hours. A request that failed releases its key, so a retry after fixing the payload runs normally.

    Up to 255 characters

Responses#

  • 200OKapplication/json

    Message

    • messagestringrequired
    • okboolean

      Default: true

    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

  • 422Validation error

    The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • validation_error · 422 — The payload was well-formed JSON but failed schema validation.
  • unauthenticated · 401 — The request carried no API key, or one the API could not verify.
  • forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
  • idempotency_key_reused · 422 — This `Idempotency-Key` was used before, for a request with a different body.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Discovered fields endpoints#

Something unclear or missing? Tell us and we’ll fix it.