API Keys

Introspect the calling key: its permissions, effective rate limits, credit status, and the webhook events available for subscription.

Self-serve info about the calling API key

get

Returns the key's own public fields (name, environment, permissions), the effective rate limits, the org's credit status, and the webhook event types available for subscriptions — so an integration can introspect its own capabilities without dashboard access.

Response envelope migration: during the current migration window, 2xx responses carry the bare payload shown in the example (the value of the schema's data property, without the {"data": ...} wrapper). The Deprecation and Sunset headers on every 2xx announce this envelope migration — they do not deprecate the endpoint itself. After the Sunset date, responses will be wrapped as {"data": ...} exactly as the schema declares.

Authorizations

AuthorizationstringRequired

API key authentication: pass your key in the Authorization header as Bearer inpk_live_... (or inpk_test_... for a test-environment key). Create and manage keys in the dashboard under Integrations Hub -> API Keys. Each key carries a permission scope (push, create, send, mcp_read, or all) and a per-minute rate limit.

Responses

200

Success

application/json

401

Unauthorized — missing or invalid credentials

application/json

429

Rate limit exceeded — see Retry-After header.

application/json

get/api/input/me

GET /api/input/me HTTP/1.1
Host: app.boundary-ai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "key": {
    "id": 77,
    "key_id": "k7jq3v9d2m",
    "display_key": "inpk_live_...x4X2b9",
    "key_suffix": "x4X2b9",
    "name": "CRM sync (production)",
    "environment": "live",
    "permissions": "push",
    "rate_limit_per_minute": 60,
    "is_active": true,
    "org_id": 412,
    "description": null,
    "created_at": "2026-06-01T09:00:00+00:00",
    "last_used_at": "2026-07-12T09:30:05+00:00",
    "revoked_at": null
  },
  "org_id": 412,
  "rate_limits": {
    "per_key_per_minute": 60,
    "per_org_per_minute": 300,
    "per_ip_per_minute": 600,
    "window_seconds": 60
  },
  "credits": {
    "limit": 10000,
    "used": 2411.5,
    "remaining": 7588.5,
    "period_start": "2026-07-01T00:00:00+00:00",
    "period_end": "2026-08-01T00:00:00+00:00",
    "rate_tokens_per_aps": 5000
  },
  "webhook_events": [
    "content.pushed",
    "survey.created",
    "survey.published",
    "series.created",
    "analysis.completed",
    "flag.raised",
    "report.ready",
    "invites.completed",
    "invite.bounced"
  ]
}