Skip to main content

Authentication

Captain.AI uses API keys sent in headers to allow access to the API. Please contact your account manager to get your API key.

Headers​

The API key should included in all API requests to the server in a header that looks like the following:

  • x-integration-key: INSERT_YOUR_KEY_HERE
  • x-developer-key: INSERT_YOUR_KEY_HERE

Please replace INSERT_YOUR_KEY_HERE with your own keys.

  • The x-integration-key is a unique key for your integration.
  • The x-developer-key is a unique key assigned to each developer of an integration.

Test your Keys​

Send a GET request to https://api.captain.ai/test/auth and you should receive a message saying you are successfully authorised.