---
title: "Get Steep Status"
method: GET
path: "/api/v1/steep/status"
tags: ["authed"]
---

# Get Steep Status

`GET /api/v1/steep/status`

## Request

- Base URL: `https://api.teaflask.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.teaflask.com/api/v1/steep/status`
- Auth: none declared

Whether capture is on for the workspace, and today's use of each
daily limit. A reached limit shows as capped, never as intake off.

## Response `200`

Successful Response

- SteepStatus: Whether capture is on, and today's use against the daily limits (UTC). Every *_today, capped, capped_meter and capped_at is null while the limits store is unreachable; capped_at is also null until capture is first refused at the limit reached.
  - `intake` 'on' | 'off', required
  - `events_today` integer, nullable, required
  - `daily_event_cap` integer, required
  - `bytes_today` integer, nullable, required
  - `daily_byte_cap` integer, required
  - `objects_today` integer, nullable, required
  - `daily_object_cap` integer, required
  - `sessions_today` integer, nullable, required
  - `daily_session_cap` integer, required
  - `capped` boolean, nullable, required: Whether a daily limit is reached.
  - `capped_meter` 'events' | 'bytes' | 'objects' | 'sessions', required: The daily meters' names: every read, cap and spend names one of these.
  - `capped_at` string, date-time, nullable, required: When capture was first refused at it today; null until then.
  - `resets_at` string, date-time, required: The next midnight UTC.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `405`: Method not allowed
- `422`: Validation error
- `500`: Internal server error

---

[API](https://skmtc.dev/teaflask/apis/teaflask-api.md) - [All operations](https://skmtc.dev/teaflask/apis/teaflask-api/llms.txt) - [OpenAPI document](https://skmtc.dev/teaflask/apis/teaflask-api/revisions/d23e9286b847?raw)