Provider credentials

Validate a provider API key

Tests an API key directly against the provider without saving it. Requires workspace owner or admin membership.

<sub>Scope: org:write</sub>

post/v3/organizations/{orgId}/provider-credentials/{providerId}/validate

Request

  • Base URL: https://api.reasonmachines.com
  • URL: https://api.reasonmachines.com/v3/organizations/{orgId}/provider-credentials/{providerId}/validate
  • Auth: HTTP bearer

Request body

keystring required

The provider API key. Write-only; never returned.

configobject

Optional non-secret provider configuration settings (e.g. AWS_REGION, CLOUDFLARE_ACCOUNT_ID, CUSTOM_ENDPOINT_BASE_URL).

Response

Validation outcome.

validboolean required

True only when the provider confirmed the key works. False for rejected or unverified outcomes; unverified does not mean the key is invalid.

outcome'verified' | 'rejected' | 'unverified' required

Validation outcome from the provider probe.

reasonstring

Failure code if rejected or unverified.

messagestring

Human-readable explanation or recommended action.

model_countnumber

Number of models discovered if verified.

Changes

No recorded changes to this operation across all 1 revision of this API.