Convilyn User Manual

API keys

An API key lets another app — the Ainalyn desktop app, the command line, or your own integration — act on your Convilyn account. You create keys in Settings → API.

Preview. API key management is currently a preview. Keys you create today aren't saved yet and won't work against the production API. This page describes how it works so you can try it out; treat it as a preview until it's generally available.

What an API key is for

A key authenticates calls made on your behalf, so you can use Convilyn outside the browser:

  • The Ainalyn desktop app — paste a key to connect the app to your account (see Convilyn & Ainalyn).
  • The command line — the convilyn CLI reads the key from your environment.
  • Your own integrations — any script or service that calls the Convilyn API.

A key acts on your behalf, so treat it like a password. Anyone who has it can spend your credits.

Create a key

  1. Open Settings → API (sign in first).
  2. Choose Create key and give it a name you'll recognize later — for example, "My desktop".
  3. Copy the full key. It starts with ck_ and is shown only once — store it somewhere safe, because you won't be able to see it again.
  4. Revoke a key at any time from the same page. Apps using it stop working immediately.

Use a key

Send the key in the Authorization header as a Bearer token:

curl https://convilyn.corenovus.com/api/v1/workflows/catalog \
  -H "Authorization: Bearer ck_your_key"

Replace ck_your_key with the key you created. For the full programmatic surface — the Python SDK, the convilyn CLI, and the REST API — see the developer documentation.

Plans and availability

API access is a Business-plan feature. While key management is in preview it is open to all signed-in users so you can try it. Cloud calls made with a key draw on the same credit balance as the web app.

Coming soon

These controls are on the way and not yet available:

  • Usage — requests and credits used per key
  • Rate limits — per-key request limits
  • Webhooks — get notified when a job finishes
  • Logs — inspect recent API requests and errors

Where to go next