Get Conductor credits

Read today's free Conductor credits and this month's paid usage.

GEThttps://api.tried.com.au/conductor/credits

Returns the Conductor credit balance. Each message costs 0.5, 1 or 3 credits by tier. Each user gets 30 free credits a day and the workspace 200; after that, messages are paid at $0.30 a credit if pay-as-you-go is on, up to the monthly limit.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/conductor/credits \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/conductor/credits", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const credits = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/conductor/credits",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
credits = res.json()

Response#

200 OK

{
  "tiers": {
    "fast": 0.5,
    "default": 1,
    "advanced": 3
  },
  "today": {
    "user_used": 0,
    "user_free_remaining": 30,
    "workspace_used": 37,
    "workspace_free_remaining": 163,
    "free_per_user": 30,
    "free_per_workspace": 200
  },
  "month": {
    "paid_credits": 0,
    "paid_cost": 0,
    "payg_enabled": false,
    "monthly_limit": 0,
    "price_per_credit": 0.3
  }
}

Field	Type	Description
`tiers`	object	Credits charged per message for each tier.
`today.user_used`, `today.user_free_remaining`	number	Free credits the caller used today and has left, of `free_per_user`. API keys have no user, so these stay at `0` and `30`.
`today.workspace_used`, `today.workspace_free_remaining`	number	Free credits the whole workspace used today and has left, of `free_per_workspace`.
`month.paid_credits`, `month.paid_cost`	number	Pay-as-you-go credits and dollars this calendar month.
`month.payg_enabled`	boolean	Whether pay-as-you-go is on. Set `conductor_payg_enabled` and `conductor_monthly_limit` with Update workspace settings.
`month.monthly_limit`	number	Most dollars of paid credits a month.
`month.price_per_credit`	number	AUD per paid credit.

Days and months are UTC.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell's public API reference has no Conductor endpoints, so this route has no Retell SDK equivalent.