Skip to main content

​
What are API Keys

API Keys are secure tokens used to authenticate your applications and services with the Orq.ai platform. Each workspace can have multiple API keys for different environments, purposes, or team members, providing controlled access to your Orq.ai resources.

​
Workspace-Level vs Project-Level API Keys

Orq.ai supports two types of API keys:
  • Workspace-Level API Keys: Created and managed in the Organization panel, these keys provide access to all resources within your workspace. Use these for applications that need broad access across multiple projects.
  • Project-Level API Keys: Automatically created when you create a new Project, these keys are scoped to a specific project and only have access to resources within that project. This provides better security isolation for individual projects.
When you create a new project, a project-level API key is automatically generated for that project. You can manage project-level keys from within the project settings.

​
Managing API Keys

API Keys can be created, viewed, and managed from your workspace settings to ensure secure access to Orq.ai services.
1

Creating a new API Key

API
  1. Navigate to your Organization panel in the Orq.ai Studio
  2. Select API Keys from the settings menu
  3. Enter a Name for your key (e.g., “Production Bot”, “Development Environment”)
  4. Click Add
  5. Preview your existing API keys
2

Revoking an API key

Revoking API
  1. Find the key in your API Keys list
  2. Click Revoke for the key you want to disable
  3. Confirm the action
Caution: Revoking an API key is permanent and cannot be undone. Make sure the key is not being used by any applications before revoking it.