Skip to main content
This endpoint returns the organization profile and the effective plan details resolved in this order:
  1. Enterprise plan
  2. Stripe subscription
  3. Free-tier fallback
It also returns the organization’s available credits in total_credits.

Request

Example curl (replace {id} and <api-key>):
curl -s \
  --request GET \
  --url "https://api.ravan.ai/api/v1/organizations/profile/{id}" \
  -H "X-Api-Key: <api-key>" \
  -H "Accept: application/json"
PowerShell (Invoke-RestMethod):
Invoke-RestMethod -Method Get -Uri "https://api.ravan.ai/api/v1/organizations/profile/{id}" -Headers @{ "X-Api-Key" = "<api-key>" }

Authorizations

X-Api-Key
string
required
Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header.
Authorization
string
Use a JWT cookie or Bearer token when your app authenticates with session-based access.
Session cookie auth is also supported for browser-based requests.
The caller must belong to the organization. If the session is an impersonated superadmin session, Agni uses the org from the token instead of the org in the URL.

Path Parameters

id
string
required
The organization UUID.

Response

id
string
Organization UUID.
name
string
Organization name.
slug
string
Organization slug.
website
string
Organization website.
status
string
Organization status.
total_credits
number
Available credits in the organization.
region_id
string
Organization region.
plan_name
string
Effective plan name.
sub_status
string
Subscription status.
period_end
string
Subscription period end timestamp.
max_concurrency
integer
Maximum concurrent sessions or jobs allowed.
max_members
integer
Maximum members allowed in the organization.
max_agents
integer
Maximum agents allowed in the organization.
max_credits
number
Maximum credits allowed for the organization.
api_rate_limit
integer
API requests allowed per window.
can_record_calls
boolean
Whether call recording is enabled.
can_use_api
boolean
Whether API access is enabled.
extra_credit_price
number
Price per extra credit.
limits
object
Effective limits returned for the organization.
{
  "id": "9b2f6d3e-1111-4c5a-9d2e-aaaaaaaaaaaa",
  "name": "Acme Inc",
  "slug": "acme-inc",
  "website": "https://acme.com",
  "status": "ACTIVE",
  "total_credits": 1250.5,
  "region_id": "us-east",
  "plan_name": "Pro",
  "sub_status": "active",
  "period_end": "2026-07-01T00:00:00Z",
  "max_concurrency": 10,
  "max_members": 25,
  "max_agents": 15,
  "max_credits": 50000,
  "api_rate_limit": 120,
  "can_record_calls": true,
  "can_use_api": true,
  "extra_credit_price": 0.02,
  "limits": {
    "api_access": true,
    "Basic_analytics": true,
    "Organization": {
      "max_orgs": 3,
      "max_members": 25
    }
  }
}