Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.knouds.ai/llms.txt

Use this file to discover all available pages before exploring further.

API keys let you authenticate requests to Knouds from scripts, CI pipelines, and external applications — anywhere you cannot use a browser session. Each key carries a scope that limits what it can do, capped by your account tier.
The full key value is shown only once, immediately after creation. Copy it before closing the dialog. If you lose the key, you must delete it and generate a new one — there is no way to retrieve the original value.
1

Go to Settings → API Keys

Sign in to knouds.ai and open Settings from the top navigation. Select the API Keys tab.You will see a list of your existing keys, each showing its name, creation date, and scope badge.
2

Click 'Create key'

Click the Create key button. A dialog opens where you configure the new key.
3

Choose a name and scope

Give the key a descriptive name that identifies where it will be used — for example, “GitHub Actions deploy” or “Mobile app production”.Then select a scope. Your available options are capped by your account tier:
ScopeDefault forWhat you can do
adminBusiness / EnterpriseRun any model, create / update / delete workflows, call the single-model endpoint
deploymentProRun deployed workflows, read workflow schemas
freeFreeRun your own deployed workflows
Scopes are cumulative — admin includes everything deployment can do, and deployment includes everything free can do.If you need a key with fewer permissions than your tier default (for example, a deployment-scoped key on a Business account), you can select the lower scope at creation time.
4

Copy the key immediately

After clicking Create, the full key value is displayed once. Copy it now and store it in a secrets manager or environment variable.The key starts with knouds_live_ and is not retrievable after you close the dialog.
5

Use the key in your requests

Pass the key in the x-api-key request header on every API call:
curl -H "x-api-key: $KNOUDS_API_KEY" \
  -H "Content-Type: application/json" \
  https://knouds.ai/api/workflows/my-flow/run \
  -X POST \
  -d '{"inputs": {"prompt": "a mountain at dusk"}}'

​
Code examples

curl -X POST https://knouds.ai/api/workflows/my-flow/run \
  -H "x-api-key: $KNOUDS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {"prompt": "a mountain at dusk"}}'

​
Storing keys safely

Never hardcode an API key in source code or commit it to a repository. Instead, load it from an environment variable: 
export KNOUDS_API_KEY="knouds_live_abc..."
In CI/CD systems (GitHub Actions, CircleCI, etc.), add KNOUDS_API_KEY as a secret in your repository settings and reference it in your workflow file.

​
Revoking a key

To revoke a key, go to Settings → API Keys, find the key in the list, and click Delete. The key is invalidated immediately — any request that uses it will receive a 401 response. There is no way to temporarily disable a key without deleting it. If you suspect a key has been compromised, delete it and create a replacement.