Skip to main content
POST
/
auth
/
provider_keys
/
test
Test Provider Key
curl --request POST \
  --url https://api.app.shinzo.ai/auth/provider_keys/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "provider_api_key": "<string>",
  "provider_base_url": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.shinzo.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Test Provider Key

Validate that an AI provider API key is working correctly without storing it in the Shinzo Platform. This is useful for verifying credentials before saving them.

​
Authentication

No authentication required.
​
provider
string
required
Provider name (anthropic)
​
provider_api_key
string
required
The API key to test
​
provider_base_url
string
Custom base URL (for proxies or self-hosted)

​
Example Request

curl -X POST https://api.app.shinzo.ai/auth/provider_keys/test \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "anthropic",
    "provider_api_key": "sk-ant-api03-..."
  }'

​
Response (Valid Key)

{
  "valid": true,
  "provider": "anthropic",
  "message": "API key is valid"
}

​
Response (Invalid Key)

{
  "valid": false,
  "provider": "anthropic",
  "error": "Authentication failed: Invalid API key"
}

​
Status Codes

CodeDescription
200Test completed (check valid field for result)
400Invalid request (missing fields, unsupported provider)

​
Supported Providers

ProviderValue
Anthropicanthropic

​
Notes

  • This endpoint does not store the API key
  • The test makes a minimal API call to verify the key is valid
  • Custom base URLs are supported for enterprise or self-hosted deployments