OtherAPI ReferenceOrganization

Get the organization's usage summary

Cost and activity per day, for each project of the organization and each model it used. Projects since deleted are included, so the per-project costs add up to the total. The window is half-open, [start_time, end_time), aggregated by whole UTC day, and must not cover more than 366 days.

GET
https://api.soniox.com/v1/organization/usage/summary

Cost and activity per day, for each project of the organization and each model it used. Projects since deleted are included, so the per-project costs add up to the total. The window is half-open, [start_time, end_time), aggregated by whole UTC day, and must not cover more than 366 days.

Headers

AuthorizationRequiredBearer <SONIOX_API_KEY>

Query parameters

start_timeRequiredstring

Start of the window (inclusive). Must be an ISO 8601 timestamp in UTC (e.g. 2026-04-01T00:00:00Z). Its UTC day is included.

end_timeRequiredstring

End of the window (exclusive). Must be an ISO 8601 timestamp in UTC (e.g. 2026-04-03T00:00:00Z) and strictly after start_time. Its UTC day is included unless it falls exactly on midnight.

Response

200

OK

totalRequiredobject

Cost and activity across every project of the organization. Equals the sum of the projects entries.

projectsRequiredarray<object>

Projects with usage in the window, highest cost first. Projects deleted since are included, so the per-project costs add up to total.

Errors

OK

{
  "total": {
    "model": "string",
    "days": [
      "2019-08-24"
    ],
    "total_cost_usd": "string",
    "total_input_cost_usd": "string",
    "total_output_cost_usd": "string",
    "total_duration_cost_usd": "string",
    "total_api_cost_usd": "string",
    "total_playground_cost_usd": "string",
    "cost_usd": [
      "string"
    ],
    "input_cost_usd": [
      "string"
    ],
    "output_cost_usd": [
      "string"
    ],
    "duration_cost_usd": [
      "string"
    ],
    "api_cost_usd": [
      "string"
    ],
    "playground_cost_usd": [
      "string"
    ],
    "total_num_requests": 0,
    "total_input_text_tokens": 0,
    "total_input_audio_tokens": 0,
    "total_input_audio_duration_ms": 0,
    "total_output_text_tokens": 0,
    "total_output_audio_tokens": 0,
    "total_output_audio_duration_ms": 0,
    "total_duration_ms": 0,
    "num_requests": [
      0
    ],
    "input_text_tokens": [
      0
    ],
    "input_audio_tokens": [
      0
    ],
    "input_audio_duration_ms": [
      0
    ],
    "output_text_tokens": [
      0
    ],
    "output_audio_tokens": [
      0
    ],
    "output_audio_duration_ms": [
      0
    ],
    "duration_ms": [
      0
    ]
  },
  "projects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "total": {
        "model": "string",
        "days": [
          "2019-08-24"
        ],
        "total_cost_usd": "string",
        "total_input_cost_usd": "string",
        "total_output_cost_usd": "string",
        "total_duration_cost_usd": "string",
        "total_api_cost_usd": "string",
        "total_playground_cost_usd": "string",
        "cost_usd": [
          "string"
        ],
        "input_cost_usd": [
          "string"
        ],
        "output_cost_usd": [
          "string"
        ],
        "duration_cost_usd": [
          "string"
        ],
        "api_cost_usd": [
          "string"
        ],
        "playground_cost_usd": [
          "string"
        ],
        "total_num_requests": 0,
        "total_input_text_tokens": 0,
        "total_input_audio_tokens": 0,
        "total_input_audio_duration_ms": 0,
        "total_output_text_tokens": 0,
        "total_output_audio_tokens": 0,
        "total_output_audio_duration_ms": 0,
        "total_duration_ms": 0,
        "num_requests": [
          0
        ],
        "input_text_tokens": [
          0
        ],
        "input_audio_tokens": [
          0
        ],
        "input_audio_duration_ms": [
          0
        ],
        "output_text_tokens": [
          0
        ],
        "output_audio_tokens": [
          0
        ],
        "output_audio_duration_ms": [
          0
        ],
        "duration_ms": [
          0
        ]
      },
      "models": [
        {
          "model": "string",
          "days": [
            "2019-08-24"
          ],
          "total_cost_usd": "string",
          "total_input_cost_usd": "string",
          "total_output_cost_usd": "string",
          "total_duration_cost_usd": "string",
          "total_api_cost_usd": "string",
          "total_playground_cost_usd": "string",
          "cost_usd": [
            "string"
          ],
          "input_cost_usd": [
            "string"
          ],
          "output_cost_usd": [
            "string"
          ],
          "duration_cost_usd": [
            "string"
          ],
          "api_cost_usd": [
            "string"
          ],
          "playground_cost_usd": [
            "string"
          ],
          "total_num_requests": 0,
          "total_input_text_tokens": 0,
          "total_input_audio_tokens": 0,
          "total_input_audio_duration_ms": 0,
          "total_output_text_tokens": 0,
          "total_output_audio_tokens": 0,
          "total_output_audio_duration_ms": 0,
          "total_duration_ms": 0,
          "num_requests": [
            0
          ],
          "input_text_tokens": [
            0
          ],
          "input_audio_tokens": [
            0
          ],
          "input_audio_duration_ms": [
            0
          ],
          "output_text_tokens": [
            0
          ],
          "output_audio_tokens": [
            0
          ],
          "output_audio_duration_ms": [
            0
          ],
          "duration_ms": [
            0
          ]
        }
      ]
    }
  ]
}

Bad Request

{
  "status_code": 0,
  "error_type": "string",
  "message": "string",
  "validation_errors": [
    {
      "error_type": "string",
      "location": "string",
      "message": "string"
    }
  ],
  "request_id": "string",
  "more_info": "string"
}

Unauthorized

{
  "status_code": 0,
  "error_type": "string",
  "message": "string",
  "validation_errors": [
    {
      "error_type": "string",
      "location": "string",
      "message": "string"
    }
  ],
  "request_id": "string",
  "more_info": "string"
}

Forbidden

{
  "status_code": 0,
  "error_type": "string",
  "message": "string",
  "validation_errors": [
    {
      "error_type": "string",
      "location": "string",
      "message": "string"
    }
  ],
  "request_id": "string",
  "more_info": "string"
}

Not Found

{
  "status_code": 0,
  "error_type": "string",
  "message": "string",
  "validation_errors": [
    {
      "error_type": "string",
      "location": "string",
      "message": "string"
    }
  ],
  "request_id": "string",
  "more_info": "string"
}

Too Many Requests

{
  "status_code": 0,
  "error_type": "string",
  "message": "string",
  "validation_errors": [
    {
      "error_type": "string",
      "location": "string",
      "message": "string"
    }
  ],
  "request_id": "string",
  "more_info": "string"
}

Internal Server Error

{
  "status_code": 0,
  "error_type": "string",
  "message": "string",
  "validation_errors": [
    {
      "error_type": "string",
      "location": "string",
      "message": "string"
    }
  ],
  "request_id": "string",
  "more_info": "string"
}