Source: https://ailoot.ai/docs/pt-pt/cabinet/usage/
Canonical: https://ailoot.ai/docs/pt-pt/cabinet/usage/
Language: pt-pt

[API da área pessoal](https://ailoot.ai/docs/pt-pt/) 

# Histórico e despesas

[Markdown](https://ailoot.ai/docs/pt-pt/cabinet/usage/index.md)

Métodos, campos dos pedidos e respostas.

Esta secção contém 11 métodos. Abra o método para consultar as condições de acesso, os campos do pedido e a resposta.

| Método e caminho | Descrição | Acesso |
| --- | --- | --- |
| `GET /api/v1/usage` | Histórico de pedidos | Token da área pessoal |
| `GET /api/v1/usage/:id` | Um pedido do histórico | Token da área pessoal |
| `POST /api/v1/usage/dashboard/api-keys-usage` | Estatísticas das suas chaves de API | Token da área pessoal |
| `GET /api/v1/usage/dashboard/models` | Utilização por modelo | Token da área pessoal |
| `GET /api/v1/usage/dashboard/snapshot-v2` | Captura unificada dos gráficos | Token da área pessoal |
| `GET /api/v1/usage/dashboard/stats` | Resumo da utilização | Token da área pessoal |
| `GET /api/v1/usage/dashboard/trend` | Evolução da utilização | Token da área pessoal |
| `GET /api/v1/usage/errors` | Histórico de erros | Token da área pessoal |
| `GET /api/v1/usage/errors/:id` | Detalhes de um erro seu | Token da área pessoal |
| `GET /api/v1/usage/stats` | Estatísticas de utilização | Token da área pessoal |
| `GET /api/v1/user/api-keys/:id/usage/daily` | Estatísticas diárias da sua chave de API | Token da área pessoal |

**GET /api/v1/usage** — Histórico de pedidos

Acesso: token da área pessoal

GET`/api/v1/usage`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `sort_by` | `string` | não | ; por predefinição: created\_at |
| `sort_order` | `string` | não | ; por predefinição: desc |
| `api_key_id` | `integer` | não |  |
| `request_type` | `string` | não |  |
| `stream` | `boolean` | não |  |
| `timezone` | `string` | não |  |
| `start_date` | `string` | não |  |
| `end_date` | `string` | não |  |
| `period` | `string` | não |  |
| `model` | `string` | não |  |
| `page` | `integer` | não | ; por predefinição: 1; positive; page\_size/limit \<=1000 |
| `page_size` | `integer` | não | ; por predefinição: 20; positive; page\_size/limit \<=1000 |
| `limit` | `integer` | não | ; por predefinição: 20; positive; page\_size/limit \<=1000 |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquemas de dados da resposta: `UsageLog`. Os campos e os tipos estão nas páginas «Esquemas de dados».

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "PLACEHOLDER_ID (integer)",
        "user_id": "PLACEHOLDER_USER_ID (integer)",
        "api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
        "request_id": "PLACEHOLDER_REQUEST_ID (string)",
        "model": "PLACEHOLDER_MODEL (string)",
        "service_tier": "PLACEHOLDER_SERVICE_TIER (string)",
        "reasoning_effort": "PLACEHOLDER_REASONING_EFFORT (string)",
        "input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
        "output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
        "cache_creation_tokens": "PLACEHOLDER_CACHE_CREATION_TOKENS (integer)",
        "cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
        "cache_creation_5m_tokens": "PLACEHOLDER_CACHE_CREATION_5M_TOKENS (integer)",
        "cache_creation_1h_tokens": "PLACEHOLDER_CACHE_CREATION_1H_TOKENS (integer)",
        "input_cost": "PLACEHOLDER_INPUT_COST (number)",
        "output_cost": "PLACEHOLDER_OUTPUT_COST (number)",
        "cache_creation_cost": "PLACEHOLDER_CACHE_CREATION_COST (number)",
        "cache_read_cost": "PLACEHOLDER_CACHE_READ_COST (number)",
        "total_cost": "PLACEHOLDER_TOTAL_COST (number)",
        "actual_cost": "PLACEHOLDER_ACTUAL_COST (number)",
        "long_context_billing_applied": "PLACEHOLDER_LONG_CONTEXT_BILLING_APPLIED (boolean)",
        "request_type": "PLACEHOLDER_REQUEST_TYPE (string)",
        "stream": "PLACEHOLDER_STREAM (boolean)",
        "duration_ms": "PLACEHOLDER_DURATION_MS (integer)",
        "first_token_ms": "PLACEHOLDER_FIRST_TOKEN_MS (integer)",
        "image_count": "PLACEHOLDER_IMAGE_COUNT (integer)",
        "image_size": "PLACEHOLDER_IMAGE_SIZE (string)",
        "image_input_size": "PLACEHOLDER_IMAGE_INPUT_SIZE (string)",
        "image_output_size": "PLACEHOLDER_IMAGE_OUTPUT_SIZE (string)",
        "image_input_tokens": "PLACEHOLDER_IMAGE_INPUT_TOKENS (integer)",
        "image_input_cost": "PLACEHOLDER_IMAGE_INPUT_COST (number)",
        "image_output_tokens": "PLACEHOLDER_IMAGE_OUTPUT_TOKENS (integer)",
        "image_output_cost": "PLACEHOLDER_IMAGE_OUTPUT_COST (number)",
        "image_size_breakdown": "PLACEHOLDER_IMAGE_SIZE_BREAKDOWN (object)",
        "media_type": "PLACEHOLDER_MEDIA_TYPE (string)",
        "ip_address": "PLACEHOLDER_IP_ADDRESS (string)",
        "session_id": "PLACEHOLDER_SESSION_ID (string)",
        "created_at": "PLACEHOLDER_CREATED_AT (string)",
        "user": "PLACEHOLDER_USER (object)",
        "api_key": "PLACEHOLDER_API_KEY (object)"
      }
    ],
    "total": "PLACEHOLDER_TOTAL (integer)",
    "page": "PLACEHOLDER_PAGE (integer)",
    "page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
    "pages": "PLACEHOLDER_PAGES (integer)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/usage/:id** — Um pedido do histórico

Acesso: token da área pessoal

GET`/api/v1/usage/:id`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/$ID" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros do caminho

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `id` | `integer` | sim |  |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquemas de dados da resposta: `UsageLog`. Os campos e os tipos estão nas páginas «Esquemas de dados».

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "user_id": "PLACEHOLDER_USER_ID (integer)",
    "api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
    "request_id": "PLACEHOLDER_REQUEST_ID (string)",
    "model": "PLACEHOLDER_MODEL (string)",
    "service_tier": "PLACEHOLDER_SERVICE_TIER (string)",
    "reasoning_effort": "PLACEHOLDER_REASONING_EFFORT (string)",
    "input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
    "output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
    "cache_creation_tokens": "PLACEHOLDER_CACHE_CREATION_TOKENS (integer)",
    "cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
    "cache_creation_5m_tokens": "PLACEHOLDER_CACHE_CREATION_5M_TOKENS (integer)",
    "cache_creation_1h_tokens": "PLACEHOLDER_CACHE_CREATION_1H_TOKENS (integer)",
    "input_cost": "PLACEHOLDER_INPUT_COST (number)",
    "output_cost": "PLACEHOLDER_OUTPUT_COST (number)",
    "cache_creation_cost": "PLACEHOLDER_CACHE_CREATION_COST (number)",
    "cache_read_cost": "PLACEHOLDER_CACHE_READ_COST (number)",
    "total_cost": "PLACEHOLDER_TOTAL_COST (number)",
    "actual_cost": "PLACEHOLDER_ACTUAL_COST (number)",
    "long_context_billing_applied": "PLACEHOLDER_LONG_CONTEXT_BILLING_APPLIED (boolean)",
    "request_type": "PLACEHOLDER_REQUEST_TYPE (string)",
    "stream": "PLACEHOLDER_STREAM (boolean)",
    "duration_ms": "PLACEHOLDER_DURATION_MS (integer)",
    "first_token_ms": "PLACEHOLDER_FIRST_TOKEN_MS (integer)",
    "image_count": "PLACEHOLDER_IMAGE_COUNT (integer)",
    "image_size": "PLACEHOLDER_IMAGE_SIZE (string)",
    "image_input_size": "PLACEHOLDER_IMAGE_INPUT_SIZE (string)",
    "image_output_size": "PLACEHOLDER_IMAGE_OUTPUT_SIZE (string)",
    "image_input_tokens": "PLACEHOLDER_IMAGE_INPUT_TOKENS (integer)",
    "image_input_cost": "PLACEHOLDER_IMAGE_INPUT_COST (number)",
    "image_output_tokens": "PLACEHOLDER_IMAGE_OUTPUT_TOKENS (integer)",
    "image_output_cost": "PLACEHOLDER_IMAGE_OUTPUT_COST (number)",
    "image_size_breakdown": "PLACEHOLDER_IMAGE_SIZE_BREAKDOWN (object)",
    "media_type": "PLACEHOLDER_MEDIA_TYPE (string)",
    "ip_address": "PLACEHOLDER_IP_ADDRESS (string)",
    "session_id": "PLACEHOLDER_SESSION_ID (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "user": "PLACEHOLDER_USER (object)",
    "api_key": "PLACEHOLDER_API_KEY (object)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**POST /api/v1/usage/dashboard/api-keys-usage** — Estatísticas das suas chaves de API

Acesso: token da área pessoal

POST`/api/v1/usage/dashboard/api-keys-usage`

## Campos JSON / formulário

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `api_key_ids` | `array` | sim | required |

Modelo do corpo do pedido

```json
{
  "api_key_ids": "PLACEHOLDER_API_KEY_IDS (array)"
}
```

PLACEHOLDER representa os seus dados de entrada e o respetivo tipo. Substitua os valores e mantenha apenas os campos opcionais necessários; não envie marcadores de texto no lugar de números, booleanos, objetos ou arrays.

Esquema do pedido: `BatchAPIKeysUsageRequest`

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquemas de dados da resposta: `BatchAPIKeyUsageStats`. Os campos e os tipos estão nas páginas «Esquemas de dados».

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "api_key_id": "PLACEHOLDER_API_KEY_ID (integer)",
    "today_actual_cost": "PLACEHOLDER_TODAY_ACTUAL_COST (number)",
    "total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

Particularidades: o método consulta as estatísticas das suas próprias chaves de API; o exemplo descreve o contrato e não é executado.

O método devolve estatísticas e não altera as chaves de API nem as despesas. Idempotency-Key não é necessário para repetir a leitura; a resposta reflete o estado no momento do pedido.

**GET /api/v1/usage/dashboard/models** — Utilização por modelo

Acesso: token da área pessoal

GET`/api/v1/usage/dashboard/models`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/models" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `api_key_id` | `integer` | não |  |
| `request_type` | `string` | não |  |
| `stream` | `boolean` | não |  |
| `timezone` | `string` | não |  |
| `start_date` | `string` | não |  |
| `end_date` | `string` | não |  |
| `period` | `string` | não |  |
| `model` | `string` | não |  |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "end_date": "VALUE_FROM_RESPONSE",
    "models": "VALUE_FROM_RESPONSE",
    "month": "VALUE_FROM_RESPONSE",
    "start_date": "VALUE_FROM_RESPONSE",
    "today": "VALUE_FROM_RESPONSE",
    "week": "VALUE_FROM_RESPONSE"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/usage/dashboard/snapshot-v2** — Captura unificada dos gráficos

Acesso: token da área pessoal

GET`/api/v1/usage/dashboard/snapshot-v2`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/snapshot-v2" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `granularity` | `string` | não | ; por predefinição: day |
| `include_trend` | `boolean` | não | ; por predefinição: true |
| `include_model_stats` | `boolean` | não | ; por predefinição: true |
| `api_key_id` | `integer` | não |  |
| `request_type` | `string` | não |  |
| `stream` | `boolean` | não |  |
| `timezone` | `string` | não |  |
| `start_date` | `string` | não |  |
| `end_date` | `string` | não |  |
| `period` | `string` | não |  |
| `model` | `string` | não |  |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "end_date": "VALUE_FROM_RESPONSE",
    "generated_at": "VALUE_FROM_RESPONSE",
    "granularity": "VALUE_FROM_RESPONSE",
    "month": "VALUE_FROM_RESPONSE",
    "start_date": "VALUE_FROM_RESPONSE",
    "today": "VALUE_FROM_RESPONSE",
    "week": "VALUE_FROM_RESPONSE"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/usage/dashboard/stats** — Resumo da utilização

Acesso: token da área pessoal

GET`/api/v1/usage/dashboard/stats`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/stats" \
  -H "Authorization: Bearer $TOKEN"
```

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquemas de dados da resposta: `UserDashboardStats`. Os campos e os tipos estão nas páginas «Esquemas de dados».

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "total_api_keys": "PLACEHOLDER_TOTAL_API_KEYS (integer)",
    "active_api_keys": "PLACEHOLDER_ACTIVE_API_KEYS (integer)",
    "total_requests": "PLACEHOLDER_TOTAL_REQUESTS (integer)",
    "total_input_tokens": "PLACEHOLDER_TOTAL_INPUT_TOKENS (integer)",
    "total_output_tokens": "PLACEHOLDER_TOTAL_OUTPUT_TOKENS (integer)",
    "total_cache_creation_tokens": "PLACEHOLDER_TOTAL_CACHE_CREATION_TOKENS (integer)",
    "total_cache_read_tokens": "PLACEHOLDER_TOTAL_CACHE_READ_TOKENS (integer)",
    "total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
    "total_cost": "PLACEHOLDER_TOTAL_COST (number)",
    "total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)",
    "today_requests": "PLACEHOLDER_TODAY_REQUESTS (integer)",
    "today_input_tokens": "PLACEHOLDER_TODAY_INPUT_TOKENS (integer)",
    "today_output_tokens": "PLACEHOLDER_TODAY_OUTPUT_TOKENS (integer)",
    "today_cache_creation_tokens": "PLACEHOLDER_TODAY_CACHE_CREATION_TOKENS (integer)",
    "today_cache_read_tokens": "PLACEHOLDER_TODAY_CACHE_READ_TOKENS (integer)",
    "today_tokens": "PLACEHOLDER_TODAY_TOKENS (integer)",
    "today_cost": "PLACEHOLDER_TODAY_COST (number)",
    "today_actual_cost": "PLACEHOLDER_TODAY_ACTUAL_COST (number)",
    "average_duration_ms": "PLACEHOLDER_AVERAGE_DURATION_MS (number)",
    "rpm": "PLACEHOLDER_RPM (integer)",
    "tpm": "PLACEHOLDER_TPM (integer)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/usage/dashboard/trend** — Evolução da utilização

Acesso: token da área pessoal

GET`/api/v1/usage/dashboard/trend`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/dashboard/trend" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `granularity` | `string` | não | ; por predefinição: day |
| `api_key_id` | `integer` | não |  |
| `request_type` | `string` | não |  |
| `stream` | `boolean` | não |  |
| `timezone` | `string` | não |  |
| `start_date` | `string` | não |  |
| `end_date` | `string` | não |  |
| `period` | `string` | não |  |
| `model` | `string` | não |  |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "end_date": "VALUE_FROM_RESPONSE",
    "granularity": "VALUE_FROM_RESPONSE",
    "month": "VALUE_FROM_RESPONSE",
    "start_date": "VALUE_FROM_RESPONSE",
    "today": "VALUE_FROM_RESPONSE",
    "trend": "VALUE_FROM_RESPONSE",
    "week": "VALUE_FROM_RESPONSE"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/usage/errors** — Histórico de erros

Acesso: token da área pessoal

GET`/api/v1/usage/errors`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/errors" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `timezone` | `string` | não |  |
| `start_date` | `string` | não |  |
| `end_date` | `string` | não |  |
| `model` | `string` | não |  |
| `api_key_id` | `integer` | não |  |
| `status_code` | `integer` | não |  |
| `category` | `string` | não |  |
| `sort_by` | `string` | não |  |
| `sort_order` | `string` | não |  |
| `page` | `integer` | não | ; por predefinição: 1; positive; page\_size/limit \<=1000 |
| `page_size` | `integer` | não | ; por predefinição: 20; positive; page\_size/limit \<=1000 |
| `limit` | `integer` | não | ; por predefinição: 20; positive; page\_size/limit \<=1000 |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      "PLACEHOLDER_DATA (object, descrição na página «Esquemas de dados»)"
    ],
    "total": "PLACEHOLDER_TOTAL (integer)",
    "page": "PLACEHOLDER_PAGE (integer)",
    "page_size": "PLACEHOLDER_PAGE_SIZE (integer)",
    "pages": "PLACEHOLDER_PAGES (integer)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/usage/errors/:id** — Detalhes de um erro seu

Acesso: token da área pessoal

GET`/api/v1/usage/errors/:id`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/errors/$ID" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros do caminho

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `id` | `integer` | sim |  |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": "PLACEHOLDER_DATA (object, descrição na página «Esquemas de dados»)"
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/usage/stats** — Estatísticas de utilização

Acesso: token da área pessoal

GET`/api/v1/usage/stats`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/usage/stats" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `api_key_id` | `integer` | não |  |
| `request_type` | `string` | não |  |
| `stream` | `boolean` | não |  |
| `timezone` | `string` | não |  |
| `start_date` | `string` | não |  |
| `end_date` | `string` | não |  |
| `period` | `string` | não |  |
| `model` | `string` | não |  |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquemas de dados da resposta: `UsageStats`. Os campos e os tipos estão nas páginas «Esquemas de dados».

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "total_requests": "PLACEHOLDER_TOTAL_REQUESTS (integer)",
    "total_input_tokens": "PLACEHOLDER_TOTAL_INPUT_TOKENS (integer)",
    "total_output_tokens": "PLACEHOLDER_TOTAL_OUTPUT_TOKENS (integer)",
    "total_cache_tokens": "PLACEHOLDER_TOTAL_CACHE_TOKENS (integer)",
    "total_cache_creation_tokens": "PLACEHOLDER_TOTAL_CACHE_CREATION_TOKENS (integer)",
    "total_cache_read_tokens": "PLACEHOLDER_TOTAL_CACHE_READ_TOKENS (integer)",
    "total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
    "total_cost": "PLACEHOLDER_TOTAL_COST (number)",
    "total_actual_cost": "PLACEHOLDER_TOTAL_ACTUAL_COST (number)",
    "average_duration_ms": "PLACEHOLDER_AVERAGE_DURATION_MS (number)",
    "endpoints": "PLACEHOLDER_ENDPOINTS (array)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

**GET /api/v1/user/api-keys/:id/usage/daily** — Estatísticas diárias da sua chave de API

Acesso: token da área pessoal

GET`/api/v1/user/api-keys/:id/usage/daily`

Leitura; o ID é obtido da sua resposta anterior

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/user/api-keys/$ID/usage/daily" \
  -H "Authorization: Bearer $TOKEN"
```

## Parâmetros do caminho

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `id` | `integer` | sim |  |

## Parâmetros de consulta

| O campo | Tipo | Obrigatório | Validação / descrição |
| --- | --- | --- | --- |
| `days` | `integer` | não | ; por predefinição: 30 |
| `timezone` | `string` | não |  |

Não é necessário corpo do pedido. Transmita os parâmetros indicados acima no URL.

## Resposta

A resposta JSON contém code, message e data. O conteúdo de data é descrito nos esquemas abaixo.

Esquemas de dados da resposta: `APIKeyDailyUsagePoint`. Os campos e os tipos estão nas páginas «Esquemas de dados».

Esquema da resposta, com valores ilustrativos

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "date": "PLACEHOLDER_DATE (string)",
    "requests": "PLACEHOLDER_REQUESTS (integer)",
    "input_tokens": "PLACEHOLDER_INPUT_TOKENS (integer)",
    "output_tokens": "PLACEHOLDER_OUTPUT_TOKENS (integer)",
    "cache_read_tokens": "PLACEHOLDER_CACHE_READ_TOKENS (integer)",
    "cache_write_tokens": "PLACEHOLDER_CACHE_WRITE_TOKENS (integer)",
    "total_tokens": "PLACEHOLDER_TOTAL_TOKENS (integer)",
    "cost": "PLACEHOLDER_COST (number)",
    "actual_cost": "PLACEHOLDER_ACTUAL_COST (number)"
  }
}
```

Particularidades: todos os dados pessoais e objetos estão limitados ao sujeito do JWT.

## Histórico e despesas · USD

total\_cost é o custo calculado segundo a tarifa; actual\_cost é o débito registado em USD.

### Exemplo de cálculo

```json
{
  "total_cost": 0.1,
  "actual_cost": 0.08
}
```

`period ∈ {today, week, month}`; `start_date, end_date: YYYY-MM-DD`; `timezone: IANA` · `timezone=UTC`. `end_date`: `[00:00, +1 day 00:00)`. `display: actual_cost.toFixed(8)`; `JSON: number`.

Ainda tem dúvidas? Envie o Request ID e uma descrição — ajudamos a esclarecer.[Contactar o suporte](mailto:support@ailoot.ai)

## Ailoot · A empresa e a sua carteira de projetos





A Ailoot assenta numa experiência operacional consolidada, numa ampla base de clientes, num serviço estável e no acompanhamento contínuo dos KPI.





A empresa e a sua carteira de projetos: milhões de clientes; vendas mensais na ordem dos milhares de milhões.





A Ailoot aplica essa experiência operacional ao acesso por API a funcionalidades de IA nos produtos dos clientes, agentes, aplicações e automatizações.
