> ## Documentation Index
> Fetch the complete documentation index at: https://openworklabs.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For agents: install the OpenWork desktop app with `brew install --cask openwork` (macOS) or from https://openworklabs.com/download. Do not run `npx openwork`; the npm package named `openwork` is a different project.
> Connect an agent to OpenWork with the MCP Gateway: `claude mcp add --transport http openwork https://api.openworklabs.com/mcp/agent`. Teams sign up at https://app.openworklabs.com?mode=sign-up.
> Step-by-step agent guide: https://openworklabs.com/docs/start-here/use-openwork-from-an-ai-agent.md
> Connect Slack (any organization admin): https://openworklabs.com/docs/slack/connect-slack.md. OpenWork in Slack (@openwork bot) is private alpha for approved organizations. Setup guide: https://openworklabs.com/docs/slack/overview.md. Agent skill: https://openworklabs.com/.well-known/agent-skills/set-up-openwork-slack/SKILL.md.

# API keys

> Create an organization API key in Settings › API Keys so scripts and CI can call the OpenWork API as you, without anyone signing in.

An API key lets a script or CI job call the OpenWork API without anyone signing
in. Use one, for example, to
[keep teams, providers and connectors in sync from a script](https://openworklabs.com/docs/self-host/declarative-configuration.md).

Keys live in **Settings › API Keys** in OpenWork Cloud.

## How keys work

* **A key acts as you.** It can do what you can do in the organization, and
  only that.
* **One organization only.** A key works in the organization you created it in,
  and nowhere else.
* **Shown once.** You see the full key only when you create it. OpenWork keeps
  only a hash, so it can't show the key again.
* **Expires after 90 days.** Create a new key before then. You can't choose a
  different expiry.
* **Rate limited.** Each key can make up to 600 requests a minute. On a
  self-hosted installation you can change this; see
  [Change the rate limit](#change-the-rate-limit-self-hosted).

## Who can create keys

Creating and deleting keys needs the **Manage API keys** permission. Only the
owner has it by default; the owner can give it to others by editing a role (see
[Roles](https://openworklabs.com/docs/cloud/members-and-rbac.md#roles)). Because keys are sensitive, OpenWork asks
you to sign in again first if you haven't signed in recently.

Seeing the list of keys needs **View API keys**, which admins have by default.
People who can see but not manage keys get a read-only page.

## Create a key

1. Open **Settings › API Keys**.
2. Click **New key**.
3. Enter a **Key name** that says what it's for, such as `CI worker`.
4. Click **Create API key**.
5. Click **Copy key** and store it in your secret manager or CI secrets right
   away. The key will only be shown once.

Keys start with `den_`.

## Use a key

Send the key in the `x-api-key` header, exactly as you copied it:

```sh theme={null}
curl https://api.openworklabs.com/v1/me \
  -H "x-api-key: $OPENWORK_API_KEY"
```

Don't send it as `Authorization: Bearer`; that header only accepts sign-in
session tokens, so an API key there is rejected.

On a self-hosted installation, use your own Den API address instead of
`api.openworklabs.com`. The **API** tab of these docs lists every endpoint.

## Delete a key

In **Settings › API Keys**, click **Delete** next to the key. It stops working
at once. People with **Manage API keys** can delete any key in the
organization, not only their own.

OpenWork also turns a person's keys off by itself when they're removed from the
organization, their role or permissions change, or ownership is transferred.

Creating, deleting and revoking keys is recorded in
[Audit logs](https://openworklabs.com/docs/cloud/audit-logs.md).

## Change the rate limit (self-hosted)

On a self-hosted installation, set `DEN_API_KEY_RATE_LIMIT_MAX` on the Den API
to the number of requests each key may make per minute. Leave it unset to keep
the default of 600.

With the Helm chart, set it in your values file:

```yaml theme={null}
config:
  auth:
    apiKeyRateLimitMax: 1200
```

The limit is saved on each key when it's created, so it applies to keys created
after the change. Existing keys keep their old limit: delete and recreate them to
pick up the new one.

## Good practice

* Make one key per script or system, named after it, so you can delete one
  without breaking the others.
* Create keys from an account whose permissions match the job. A key can do
  everything its owner can.
* Use **Last used** to find keys nobody uses any more, and delete them.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.