BizKitHub
DocsAPI ReferenceOrganisation/bff/organisation-ai/test-connection
postOrganisationAdmin BFF

/bff/organisation-ai/test-connection

Runs a minimal probe call against the provider using the currently stored key so the admin can verify it still works after e.g. rotating the key upstream. Never returns the key itself.

OrganisationpostBffOrganisation-aiTest-connection

Parameters

JSON body

Request body

application/json
provider"google" | "openai" | "anthropic"Required

Response schema

1 status code documented

200Success
successbooleanRequired
messagestringRequired

Response example

application/json
{
  "success": false,
  "message": "example_message"
}

Request example

POST /bff/organisation-ai/test-connection

post
curl -X POST "https://api.bizkithub.com/bff/organisation-ai/test-connection" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key