Skip to main content
GET
Validate API key

Authorizations

api_key
string
header
required

Response

API key is valid

_metadata
object
required
status
enum<string>
required

Status of the API key validation

Available options:
ok
Example:

"ok"

valid
boolean
required

Whether the API key is valid

Example:

true

workspaceOId
string
required

The unique identifier for the workspace

Example:

"wks_abc123"

workspaceName
string
required

The name of the workspace

Example:

"My Workspace"

workspaceDomain
string | null
required

The domain associated with the workspace

Example:

"example.com"

organizationOId
string
required

The unique identifier for the organization

Example:

"org_xyz789"

organizationName
string
required

The name of the organization

Example:

"Acme Corp"

organizationDomain
string
required

The domain associated with the organization

Example:

"acme.com"

organizationSlug
string
required

The URL-friendly slug for the organization

Example:

"acme-corp"

mcpUrl
string
required

The MCP server URL with encoded workspace context for connecting AI tools

Example:

"https://mcp.octavehq.com/mcp?ctx=eyJvcmdhbml6YXRpb25fc2x1ZyI6ImFjbWUtY29ycCIsIndvcmtzcGFjZV9vX2lkIjoid2tzX2FiYzEyMyJ9"

credits
object
required

Credit usage information for the API key