AI
Agents

Test what a chat's credential card typed, before saving (owner only)

Runs one cheap read with the values on an open credential card: the connector's own validation, or the custom connector's declared test. Answers with the outcome only (connected, rejected, insufficient, unreachable, untested) and who the key belongs to when the provider says. The values are not stored or logged.

post/agents/sessions/{session_id}/credential-test

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/agents/sessions/{session_id}/credential-test
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

session_idstring required

Request body

widget_idstring required
credentialsobject required

Response

Request fulfilled, document follows

outcomestring required
identitystring
orgstring
seesobject[]
readsstring

Changes

No recorded changes to this operation across all 3 revisions of this API.