Skip to main content
POST
Test an AI key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string | null

Path Parameters

key_id
string<uuid>
required

Response

What the provider said, and the key's recorded state

key
PersonalAIKey · object
required

The key with the state the test recorded.

is_valid
boolean
required

Whether the provider accepted the key.

message
string
required

Why the test failed, in words you can act on; empty when it passed.