curl --request POST \
--url https://breadbox.example.com/api/v1/providers/{name}/test \
--header 'X-API-Key: <api-key>'{
"provider": "<string>",
"ok": true,
"message": "<string>"
}Round-trip a provider credentials check
Validates the server-side credentials for the named provider. CSV has
no credentials and always returns ok=true. Plaid hits
/institutions/get with a tiny payload; Teller validates the stored
cert/key pair (file path or in-memory PEM) against crypto/tls.
A reachable server with bad credentials still returns 200 with
ok=false and a human-readable message, so CLI agents can branch on
the JSON without parsing status codes.
Requires full_access scope.
curl --request POST \
--url https://breadbox.example.com/api/v1/providers/{name}/test \
--header 'X-API-Key: <api-key>'{
"provider": "<string>",
"ok": true,
"message": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Breadbox API key with format bb_<base62>. Carries either read_only
or full_access scope. Write endpoints (and a handful of sensitive
reads — /api-keys, /users/{user_id}/login) require full_access;
endpoints that require it are flagged in their description.
Path Parameters
plaid, teller, csv