AI usage

GET /engagements/{engagement}/costs

Read engagements.costs

Parameters

engagement path: Identifier (ULID).
cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/engagements/{engagement}/costs" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/alerts

Read usage.alerts

Parameters

cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/alerts" \
  -H "Authorization: Bearer pat_…"

POST /workspace/usage/alerts/{alert}/acknowledge

Write usage.alerts.acknowledge

Parameters

alert path: Identifier (ULID).

Responses

201 Created (200 or 202 for an action or an asynchronous job).
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl -X POST "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/alerts/{alert}/acknowledge" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/budget

Read usage.budget

Parameters

cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/budget" \
  -H "Authorization: Bearer pat_…"

PUT /workspace/usage/budget

Write usage.budget.save

Body application/json

monthly_amount number required

at least 1 at most 1000000
warning_ratio number

at least 0 at most 0
include_tests boolean

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl -X PUT "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/budget" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"monthly_amount":1}'

DELETE /workspace/usage/budget

Write usage.budget.delete

Responses

204 Deleted, no content.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl -X DELETE "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/budget" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/dashboard

Read usage.dashboard

Parameters

cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/dashboard" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/entries

Read usage.entries

Parameters

cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/entries" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/export

Read usage.export

Parameters

cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/export" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/options

Read usage.options

Parameters

cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/options" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/summary

Read usage.summary

Parameters

cursor limit query: Cursor pagination, for operations that return a paginated list.

Responses

200 Success: the resource in data.
401 Missing, invalid, revoked or expired token.
403 Not allowed by the role, a rule or the scope.
404 Unknown resource or outside the workspace.
422 Invalid data (validation.failed).
429 Rate limit reached.

Example

curl "https://{your-workspace}.tellmehow.io/api/v1/workspace/usage/summary" \
  -H "Authorization: Bearer pat_…"