Obter conta e uso

GET /v1/me — o workspace, a API key e o plano por trás de uma chave, mais o uso deste período de cobrança. Verifique uma chave no CI e acompanhe a sua cota pelo código.

GET https://api.dcision.io/v1/me

Devolve a quem uma API key pertence — o workspace, a própria chave e o plano — e as decisões cobráveis usadas no período de cobrança atual. Use para verificar uma chave no CI ou na inicialização, e para mostrar a cota ou alertar sobre ela a partir do seu próprio código.

Requisição

Sem parâmetros e sem body. Autentique com as mesmas API keys das decisões:

curl https://api.dcision.io/v1/me \
  -H "Authorization: Bearer $DCISION_API_KEY"

Resposta

200 OK
{
  "workspace": { "id": "4c8f2a91-6d3b-4e7a-9f15-2b0c7d8e6a43", "name": "Acme", "external_id": null, "parent": null },
  "workspace_usage": null,
  "api_key": {
    "id": "key_7Hq2Lm9Xc4Rv1Tz8Wn3B",
    "name": "Production",
    "prefix": "dcs_live_9fK2…0Ad2",
    "environment": "live"
  },
  "plan": {
    "id": "growth",
    "name": "Growth",
    "rate_limit_per_minute": 2000,
    "max_decisions": null,
    "log_retention_days": 30,
    "hard_cap": false
  },
  "usage": {
    "used": 1284311,
    "included": 10000000,
    "period_start": "2026-10-01T00:00:00.000Z",
    "period_end": "2026-11-01T00:00:00.000Z"
  }
}
CampoTipoDescrição
workspace.idstringO ID do workspace.
workspace.namestringO nome do workspace.
workspace.external_idstring | nullModo parceiro: com o header Dcision-Workspace, o external_id do sub-workspace; caso contrário, null.
workspace.parentobject | nullCom o header Dcision-Workspace: { "id", "name" } do seu workspace, que paga pelo sub-workspace. plan e usage são então os seus.
workspace_usageobject | nullCom o header Dcision-Workspace: { "used", "limit", "period_start", "period_end" } — as execuções cobráveis do sub-workspace neste ciclo e o limite dele (null = nenhum).
api_key.idstringO ID da chave (key_…).
api_key.namestringO nome dado à chave em API Keys.
api_key.prefixstringA chave mascarada, como aparece no app — nunca o secret completo.
api_key.environmentstringlive ou test.
plan.idstringgenesis, developer, growth ou enterprise.
plan.namestringO nome de exibição do plano.
plan.rate_limit_per_minuteintegerRequisições por minuto permitidas para o workspace — veja Rate limits.
plan.max_decisionsinteger or nullQuantas decisões o workspace pode ter; null é ilimitado.
plan.log_retention_daysintegerPor quanto tempo o plano guarda as execuções.
plan.hard_capbooleantrue quando o plano não pode continuar com créditos: as chamadas são bloqueadas com 402 QUOTA_EXCEEDED assim que o volume incluído se esgota. false no Genesis, Developer e Growth — depois do volume incluído eles usam créditos.
usage.usedintegerDecisões cobráveis no período atual.
usage.includedintegerDecisões incluídas no período atual — nos planos anuais, o pacote do ano inteiro.
usage.period_startstringInício do período de cobrança atual, ISO 8601.
usage.period_endstringFim do período de cobrança atual, ISO 8601.

O período de cobrança é o ciclo da assinatura nos planos pagos e o mês do calendário em UTC no Genesis — veja Planos, cotas e cobrança.

Exemplos

Faça um job de CI falhar cedo quando a chave estiver errada:

dcision_me=$(curl -sf https://api.dcision.io/v1/me -H "Authorization: Bearer $DCISION_API_KEY") \
  || { echo "Invalid Dcision API key" >&2; exit 1; }
echo "$dcision_me" | jq -r '"\(.workspace.name) · \(.api_key.environment) · \(.plan.name)"'

Avise antes de o volume incluído acabar — depois dele, as decisões usam créditos:

const me = await fetch("https://api.dcision.io/v1/me", {
  headers: { Authorization: `Bearer ${process.env.DCISION_API_KEY}` },
}).then((response) => response.json());

const share = me.usage.used / me.usage.included;
if (share >= 0.9) alert(`Dcision: ${Math.round(share * 100)}% of the included volume used`);

Erros

StatusCódigoQuando
401INVALID_API_KEYA chave está ausente, malformada, é desconhecida ou foi revogada.
429RATE_LIMITEDRequisições de leitura demais no minuto atual.

Os endpoints de leitura — GET /v1/me e GET /v1/executions — compartilham uma janela de rate limit própria, com o limite por minuto do seu plano, então consultá-los com frequência nunca deixa as suas decisões mais lentas. Leituras não são cobradas.

Nesta página