Account Management

Check your account status, view usage, and update settings programmatically.

All endpoints in this section require x-access-key and x-user-id headers.

Get Account Status

Returns your current account status including balance, seat usage, and trial information.

Endpoint: POST https://api.warmai.uk/functions/v1/api-account-status

Headers:

Header	Required	Description
`x-access-key`	Yes	Your API access key
`x-user-id`	Yes	Your user ID

Response:


{
  "balance": 150.00,
  "seats_used": 3,
  "is_trial": false,
  "trial_ends_at": null
}

Field	Type	Description
`balance`	number	Current credit balance
`seats_used`	number	Number of active user seats
`is_trial`	boolean	Whether the account is on a trial plan
`trial_ends_at`	string \| null	ISO 8601 timestamp when trial expires, or `null` if not on trial

Get Usage Summary

Returns a summary of your API usage for a given period.

Endpoint: POST https://api.warmai.uk/functions/v1/api-usage-summary

Headers:

Header	Required	Description
`x-access-key`	Yes	Your API access key
`x-user-id`	Yes	Your user ID

Request Body:


{
  "period": "month"
}

Field	Type	Required	Description
`period`	string	Yes	One of `day`, `week`, `month`, or `all`

Response:


{
  "credits_used": 45.50,
  "api_calls": 312,
  "by_operation": {
    "research": 150,
    "message": 120,
    "connect": 42
  },
  "transactions": [
    {
      "id": "txn_abc123",
      "type": "debit",
      "amount": 0.15,
      "operation": "research",
      "created_at": "2026-03-18T14:30:00Z"
    }
  ]
}

Field	Type	Description
`credits_used`	number	Total credits consumed in the period
`api_calls`	number	Total API calls made in the period
`by_operation`	object	Breakdown of calls by operation type
`transactions`	array	List of individual transactions

Update Settings

Update your account-level settings such as webhook configuration and allowed domains.

Endpoint: POST https://api.warmai.uk/functions/v1/api-update-settings

Headers:

Header	Required	Description
`x-access-key`	Yes	Your API access key
`x-user-id`	Yes	Your user ID

Request Body:

Only include the fields you want to update.


{
  "webhook_url": "https://example.com/webhooks/warmai",
  "webhook_secret": "whsec_your_secret_here",
  "auto_reload_enabled": true,
  "auto_reload_threshold": 10.00,
  "allowed_domains": ["example.com", "app.example.com"]
}

Field	Type	Description
`webhook_url`	string	HTTPS URL to receive webhook events
`webhook_secret`	string	Secret used to sign webhook payloads
`auto_reload_enabled`	boolean	Whether to automatically reload credits when balance is low
`auto_reload_threshold`	number	Credit balance at which auto-reload triggers
`allowed_domains`	array	List of allowed domains (maximum 5)

Response:


{
  "success": true,
  "updated_fields": ["webhook_url", "webhook_secret"]
}