Skip to main content
API keys give a client application (iOS, Android, React, web) or a backend access to one project without a user sign-in. What a key can do depends on whether it has scopes. The Metabind web application uses JWT authentication instead.

Key Principles

Project Scoping

Each API key is scoped to a specific project and cannot access resources across projects. This provides a simplified permission model for client applications.

Scopes

  • Unscoped keys have full access within their project. Keys created in Studio, or through the API without scopes, are unscoped.
  • Scoped keys can do only what their scopes allow. Set scopes when you create the key. For example, ["read:content"] reads published content, and ["execute:mcp", "read:types"] connects to the production MCP URL.
  • Reading drafts, such as draft content types (/types?draft=true) and the draft package (/packages/draft), needs execute:mcp-draft on a scoped key, in addition to the resource’s own read scope (read:types or read:packages).
  • A request the key’s scopes don’t cover returns 403 with the code INSUFFICIENT_SCOPE.
  • Keys can be revoked at any time.
Scopes take the form action:resource. The actions are read, write, delete and publish, and the resources include content, components, types, packages, assets, projects and apiKeys. MCP access uses execute:mcp and execute:mcp-draft.

Client Integration

API keys work in client-side applications and on backends:
  • Easily integrates with mobile and web applications
  • Used as header parameter (x-api-key) in API requests
  • No token refresh or expiration management required

Security

  • A key that ships inside an app can be extracted from it. Give a client key only the read scopes it needs, and keep unscoped keys on a backend.
  • Keys don’t expire. Revoke a key that may have leaked.
  • Activity is logged and monitored

The API Key Object

string
Unique identifier
string
Descriptive name for the key (e.g., “iOS App Production”)
string
The actual API key value (only shown at creation time)
string[]
The key’s scopes. Absent on an unscoped key, which has full access within its project.
string
Status: active or revoked
string
Last time the key was used (ISO 8601 format)
string
ID of the user who created the key
string
Creation timestamp (ISO 8601 format)
string
Last update timestamp (ISO 8601 format)

Example Object

The API key value is only returned once during creation. Store it securely as it cannot be retrieved later.

Client API Endpoints

For the complete list of endpoints accessible via API keys, see the Client API Endpoints section in the Authentication documentation.

Using API Keys

Include the API key in the x-api-key header:
For detailed integration examples including iOS, Android, and React implementations, see Using API Keys.