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>"
}
'

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>"
}
'

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.

string

required

Provider name (anthropic)

string

required

The API key to test

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

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

Supported Providers

Provider	Value
Anthropic	`anthropic`

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

Provider Keys Overview Save Provider Key

Overview

Authentication

AI Agents

Agent Messaging

Agent Schedules & Triggers

Agent Channels

Agent Filesystem

MCP Servers

Spotlight

Tokens

Provider Keys

Telemetry

Test Provider Key

Test Provider Key

Authentication

Example Request

Response (Valid Key)

Response (Invalid Key)

Status Codes

Supported Providers

Notes

​Test Provider Key

​Authentication

​Example Request

​Response (Valid Key)

​Response (Invalid Key)

​Status Codes

​Supported Providers

​Notes

Test Provider Key

Authentication

Example Request

Response (Valid Key)

Response (Invalid Key)

Status Codes

Supported Providers

Notes