Inference Providers

Test an inference gateway provider before adding it

Changed on

Sends one short test prompt through AI Gateway to the trusted catalog provider with an unsaved organization credential (credential, apiKeys, or reuseCredentialFrom for Amazon Bedrock), the destination settings and one catalog model. Nothing is stored and no usage is recorded. ok=false carries a message for the admin that never contains the key. May consume a few tokens on the provider account. Requires the gatewayProviderTest feature, the Manage Gateway providers permission and enabled Gateway management; a person must send it, never the agent or an API key. Limited to 20 tests per member and 60 per organization every ten minutes.

post/v1/inference-providers/test-connection

Request

  • Base URL
    https://api.openworklabs.com
  • URL
    https://api.openworklabs.com/v1/inference-providers/test-connection
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Request body

providerIdstring required
modelstring required
apiKeysobject
reuseCredentialFromstring typeid

Amazon Bedrock only: copy the organization AWS keys of another Amazon Bedrock provider in this organization, server-side. Mutually exclusive with credential and apiKeys.

Response

Test an inference gateway provider before adding it

okboolean required
modelstring required
statusinteger nullable required
codestring nullable required
messagestring nullable required

Changes