API Keys
API keys authenticate requests to the doccape REST API. Send the key on every request as an HTTP Bearer token:
Authorization: Bearer YOUR_API_KEY
Treat keys as secrets — never commit them to source control or expose them in client-side code. Store them in a password manager, secrets store, or server-side environment variable.
How to create a user-scoped API key
After you have a verified account and are signed in at app.doccape.de, create a user-scoped key from the Developers page:
- In the app, open the Developers page (located in the sidebar).
- Choose **User API Keys" in the tab selection.
- Click Add.
- Give the key a name, then generate it.
Copy the key immediately and store it somewhere safe. The full key is shown only once. After you close the dialog, only a masked value remains.
How to create a project-scoped API key
Project-scoped **API Keys" can only be created by organization admins or project admins. Organization admins can create project-scoped API Keys for every project in their organization. A user that is admin in one or more projects can create project-scoped API Keys for every project they are an admin in.
You can create a project-scoped key from the Developers page:
- In the app, open the Developers page (located in the sidebar).
- Choose **Project API Keys" in the tab selection.
- Open the accordion of the project for which you want to create an API Key for.
- Click Add.
- Give the key a name, then generate it.
Copy the key immediately and store it somewhere safe. The full key is shown only once. After you close the dialog, only a masked value remains.
How to create a organization-scoped API key
Organization-scoped **API Keys" can only be created by organization admins. An organization-scoped API Key is able to access ALL document in ALL projects of the organization.
You can create an organization-scoped key from the Developers page:
- In the app, open the Developers page (located in the sidebar).
- Choose **Organization API Keys" in the tab selection.
- Click Add.
- Give the key a name, then generate it.
Copy the key immediately and store it somewhere safe. The full key is shown only once. After you close the dialog, only a masked value remains.
Scopes
Credentials can be scoped differently. Scope controls which projects the key can access:
| Key type | Scope | Typical use |
|---|---|---|
| User API key | Projects you are a member of in your organization | Personal scripts and integrations tied to your membership |
Project API key (dcpk_…) | Only the one project bound to the key | Lock a credential to one project |
Organization API key (dcok_…) | All projects in that organization | Shared automation across the whole organization |
For endpoints without a {projectId}, the API resolves the default project:
- User or organization key → the organization’s default project
- Project key → the project bound to that key
List projects visible to your current key with GET /external/v1/projects/me.