Create API Key | Rightbrain Docs | Transform AI Ideas into Production Tasks

Create a new API key for authenticating API requests.

API keys provide a simpler alternative to OAuth for programmatic access. Each key:

Is tied to the creating user and inherits their permissions
Can be used to authenticate requests to any project endpoint
Has a descriptive name for easy management
Can be revoked at any time

The API key is only shown once at creation time and cannot be retrieved later.

Security Notes:

Store API keys securely (use environment variables, not hardcode)
Rotate keys regularly
Each key inherits the user’s project permissions
Revoke compromised keys immediately

Create a new API key for authenticating API requests. API keys provide a simpler alternative to OAuth for programmatic access. Each key: - Is tied to the creating user and inherits their permissions - Can be used to authenticate requests to any project endpoint - Has a descriptive name for easy management - Can be revoked at any time The API key is only shown once at creation time and cannot be retrieved later. **Security Notes**: - Store API keys securely (use environment variables, not hardcode) - Rotate keys regularly - Each key inherits the user's project permissions - Revoke compromised keys immediately

Authentication

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

Path Parameters

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

Request

This endpoint expects an object.

namestringRequired

Response

Successful Response

namestring

idstringformat: "uuid"

keystring

oauth_client_idstringformat: "uuid"

createdstringformat: "date-time"

revokedboolean

last_usedstring or nullformat: "date-time"

1	import requests
2
3	url = "https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/api_key"
4
5	payload = {
6	"name": "CI/CD Pipeline Key",
7	"description": "Used by GitHub Actions for automated deployments"
8	}
9	headers = {
10	"Authorization": "Bearer <token>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"name": "string",
3	"id": "string",
4	"key": "string",
5	"oauth_client_id": "string",
6	"created": "2024-01-15T09:30:00Z",
7	"revoked": true,
8	"last_used": "2024-01-15T09:30:00Z"
9	}

Authentication

Path Parameters

Request

Response

Errors