Create an API Key
To get started with the CaptionKit API, you'll need an API Key. This is your way to keep your API requests safe and secure.
Navigate to βοΈ Account settings and scroll down to API Keys, then click Create a new key. Give your API a label then confirm. In future CaptionKit will support multiple API keys, so make sure to use a descriptive label.
API keys are unique to your account and should be kept secret. If you believe your API key has been compromised, you can delete it and create a new one at any time.
Authentication
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Making a request
To authenticate your requests, you will need to include the API key in one of 3 areas.
Authorization header
Include your API key in the Authorization
header of your request. The value should be Bearer {API_KEY}
- make sure to replace {API_KEY}
with your actual API key.
curl https://api.captionkit.io/v2/signal -H "Authorization: Bearer {API_KEY}"
X-API-Key header
Include your API key in the X-API-Key
header of your request. Make sure to replace replace {API_KEY}
in the example with your actual API key.
curl https://api.captionkit.io/v2/signal -H "X-API-Key: {API_KEY}"
Query parameter
Include your API key in a key
query parameter. This can be appended to your url with &key={API_KEY}
, or &key={API_KEY}
if you have other parameters. Make sure to replace {API_KEY}
with your actual API key.
curl https://api.captionkit.io/v2/signal?key={API_KEY}