Skip to main content
GET
/
api
/
v2
/
api-key
/
validate
Validate API key
curl --request GET \
  --url https://app.octavehq.com/api/v2/api-key/validate \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "status": "ok",
  "valid": true,
  "workspaceOId": "wks_abc123",
  "workspaceName": "My Workspace",
  "workspaceDomain": "example.com",
  "organizationOId": "org_xyz789",
  "organizationName": "Acme Corp",
  "organizationDomain": "acme.com",
  "organizationSlug": "acme-corp",
  "credits": {
    "totalUsed": 175,
    "totalRemaining": 425,
    "totalMax": 575,
    "quotaUsed": 150,
    "quotaAvailable": 350,
    "quotaMax": 500,
    "period": "month",
    "creditsUsed": 25,
    "creditsAvailable": 75
  }
}

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"

​
credits
object
required

Credit usage information for the API key