Skip to main content
Manage Duckie API keys from Settings -> API & MCP. The API & MCP section shows each key’s name, preview, scopes, creator, created time, last-used time, expiration, and status. It also includes an MCP endpoint panel with the endpoint URL, auth header format, JSON-RPC examples, and a connection test for a stored customer API key.

Create a Key

1

Open API & MCP

Go to Settings -> API & MCP.
2

Create a key

Click Create key.
3

Name the key

Use a name that identifies the integration or environment, such as Warehouse export or Production reporting.
4

Choose scopes

Select the read scopes this key should have. All read scopes are selected by default.
5

Choose an expiration

Select No expiration, 90 days, or 1 year.
6

Store the key

Copy the full key from the one-time reveal dialog and store it in your secret manager.
The full API key is shown only once. Duckie stores a hash and a preview after creation.

Scopes

Scopes are grouped by how they are used.

Customer API

These scopes control direct /api/v1 requests.
Scope labelScope valueAllows
Runsapi:runs:readRead runs and run tool filter options
Toolsapi:tools:readRead tools
Agentsapi:agents:readRead agents
Guidelinesapi:guidelines:readRead guidelines
Guardrailsapi:guardrails:readRead guardrails
Runbooksapi:runbooks:readRead runbooks

Duckie Assistant MCP

These scopes control the first-party Duckie Assistant MCP core object tools.
Scope labelScope valueAllows
Core objects readapi:core:readDescribe, list, and retrieve core objects through MCP
Core objects writeapi:core:writeCreate, update, and delete writable core objects through MCP
Create separate keys for separate integrations when they need different scopes or rotation schedules. MCP clients see only the wrapper tools allowed by the key’s scopes. For example, a key with api:runs:read can list and retrieve runs through MCP, and a key with api:core:write can call MCP write tools for writable core objects.

Rename a Key

Use rename when the integration name changes or you want a clearer label. Renaming changes only the display name. The API key value and scopes stay the same.

Revoke a Key

Revoking a key stops new requests with that key immediately.
1

Find the key

Go to Settings -> API & MCP and find the key in the table.
2

Revoke

Click the revoke action and confirm.
3

Rotate integrations

Update any integration that used the revoked key with a newly created key.

Statuses

StatusMeaning
ActiveThe key can authenticate requests until it expires or is revoked
ExpiredThe key is past its configured expiration
RevokedThe key was manually revoked