Workspace

Workspace of the API key, plan limits and usage

GET/v1/workspace

Authentication: API key (Authorization: Bearer)
Required scope: read

Responses#

200Workspace.

Response headers

RateLimit-Limitinteger
Requests allowed per window.
RateLimit-Remaininginteger
Requests left in the current window.
RateLimit-Resetinteger
Seconds until the window resets.
RateLimit-Policystring
e.g. 10;w=1.
Aicscan-Daily-Quota-Limitinteger
Calls allowed per UTC day (plans with a daily quota).
Aicscan-Daily-Quota-Remaininginteger
Calls left today (UTC).

Object fields

workspaceobject
Object fields
- idstring · uuid
- namestring
- planstring
- statestring
  Values active suspended
- created_atstring · date-time
planobject
Object fields
- codestring
- namestring
limitsobject
From the workspace's plan. null = unlimited.
Object fields
- addressesintegernullable
- rulesintegernullable
- channelsintegernullable
- channel_kindsarray of stringnullable
  null = all kinds.
- chainsintegernullable
- requests_per_secondinteger
  Applied to this key.
- requests_per_dayintegernullable
- immediate_alertboolean
usageobject
Object fields
- addressesinteger
- rulesinteger
- channelsinteger
- requests_todayinteger
  Calls served today (UTC).
api_keyobject
Object fields
- idstring · uuid
- prefixstring
- scopesarray of string
  Values read write

4xx · 5xxError.

Standard error format: see Errors.

Request

cURL

curl "https://aicscan.io/v1/workspace" \
  -H "Authorization: Bearer $AICSCAN_API_KEY"

JavaScript

const res = await fetch('https://aicscan.io/v1/workspace', {
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os
import requests

resp = requests.get(
    "https://aicscan.io/v1/workspace",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Response 200

JSON

{
  "workspace": {
    "id": "0193a1b2-0c1d-7e4f-8a9b-1c2d3e4f5a01",
    "name": "Acme Treasury",
    "plan": "pro",
    "state": "active",
    "created_at": "2026-10-02T08:00:00Z"
  },
  "plan": {
    "code": "pro",
    "name": "Pro"
  },
  "limits": {
    "addresses": 100,
    "rules": null,
    "channels": 10,
    "channel_kinds": null,
    "chains": null,
    "requests_per_second": 25,
    "requests_per_day": 10000,
    "immediate_alert": true
  },
  "usage": {
    "addresses": 12,
    "rules": 4,
    "channels": 3,
    "requests_today": 318
  },
  "api_key": {
    "id": "0193a1a0-77b1-7c3d-8e9f-0a1b2c3d4e5f",
    "prefix": "aic_k3J9xQ2a",
    "scopes": [
      "read",
      "write"
    ]
  }
}