API Keys

Access CrowdRunner programmatically via API keys.

Creating an API Key

1. Go to Settings in the dashboard.
2. Scroll to the API Keys section.
3. Click Create API Key and give it a descriptive name (e.g. "CI Pipeline" or "Chrome Extension").
4. Copy the key immediately — it is only shown once and cannot be retrieved later.

Using API Keys

Include your API key in the Authorization header of HTTP requests:

Authorization: Bearer cr_your_api_key_here

The API base URL is your CrowdRunner backend followed by /api/v1/. Common endpoints:

• POST /api/v1/tests — Create and launch a test
• GET /api/v1/tests — List your tests
• GET /api/v1/tests/:id — Get test details and results
• GET /api/v1/users/me/usage — Check your usage and quota

Use Cases

CI/CD Integration

Run UX tests automatically on every deploy. Add a step to your CI pipeline that creates a test via the API and polls for results. Fail the build if satisfaction scores drop below a threshold.

Chrome Extension

The Chrome Extension uses an API key to authenticate with CrowdRunner. Create a dedicated key named "Chrome Extension" for this purpose.

MCP Integration

Use CrowdRunner from AI coding tools (like Claude Code or Codex) via the MCP server. The MCP server uses your API key to run tests and fetch results programmatically.

Managing Keys

• View all your keys in Settings → API Keys. Each key shows its name, creation date, and when it was last used.
• Revoke keys you no longer need. Revoked keys stop working immediately.
• Give keys descriptive names so you can identify what each one is used for.

Security Best Practices

• Never commit API keys to version control. Use environment variables or a secrets manager.
• Create separate keys for different integrations (one for CI, one for the extension, etc.) so you can revoke them independently.
• Revoke compromised keys immediately from the Settings page.
• Rotate keys periodically, especially for production integrations.