Skip to main content

Overview

To authenticate with CaptureKit, you need:
  1. API Key — an API key from the API page of your CaptureKit dashboard.
This guide will show you how to create it.

Prerequisites

  • A CaptureKit account. If you don’t have one, sign up with an email address, Google or GitHub. New accounts start with free credits, so no credit card is needed to try the API.

Step 1: Create an API key

  1. Sign in to the CaptureKit dashboard.
  2. Click API in the left sidebar to open your API keys, then click New API key.
CaptureKit API keys page with the New API key button
  1. Enter a name for the key and, optionally, pick a Category. An expiry date and request limits are optional. Click Create API key.
CaptureKit New API key dialog with the name and Category fields and the Create API key button
  1. Copy the API key from the API key created dialog right away: it is shown only once and cannot be retrieved again. Then click Accept and continue.
CaptureKit API key created dialog showing the new API key

Step 2: Enter your API key in the Connect UI

  1. Open the form where you need to authenticate with CaptureKit.
  2. Enter your API key in the API Key field.
  3. Submit the form, and you should be successfully authenticated.
CaptureKit Connect UI form with the API Key field You are now connected to CaptureKit.