Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Key management

API key management guidance for the Perceptis API.

API keys are created and managed in Developer Settings in the Perceptis web app. Use them to authenticate calls to POST /api/v1/generate and GET /api/v1/status/{job_id}.

Key creation and API usage require a paid Business or Enterprise organization plan. Free, Starter, and trial organizations are not eligible.

Create a key

  1. Open Developer Settings.

  2. Create a new API key.

  3. Copy the plaintext key when it is shown.

  4. Store it in a secret manager or environment variable.

The plaintext key is shown only once. If you lose it, create a replacement key and revoke the old one.

Use a key

Send the key as a bearer token:

Authorization: Bearer <your-api-key>

A job can be polled only with the same API key that created it.

Revoke a key

Revoke keys you no longer use from Developer Settings. Revoked keys stop authenticating Perceptis API requests and receive 401.

Recommended practices

  • Use separate keys for separate integrations.

  • Rotate keys on a regular schedule.

  • Revoke keys immediately if they may have been exposed.

  • Do not store keys in source control, client-side code, logs, or analytics tools.

See also

PreviousGET /api/v1/status/{job_id}

Last updated

Was this helpful?