API

The console uses the same API that is available to integrations. The API describes itself in an OpenAPI document, which is not yet exposed on the public host; ask ScaiLabs for a copy. Paths may still change before general availability.

Conventions#

• Base URL: https://scailine.scailabs.ai/v1.
• Authentication: Authorization: Bearer <token>, where the token is one of:
  • a console session (ScaiKey sign-in through /auth/login and /auth/callback);
  • an API key (slk_…), created under API keys in the console. A key carries a subset of its creator's permissions and can expire; the plaintext is shown once;
  • a milter node token (smn_…), valid only for the milter endpoints.
• Permissions: every endpoint requires a permission (templates.write, rules.read, …) from the caller's roles (tenant_admin, designer, campaign_manager, legal, auditor, user). Roles come from ScaiKey groups or are assigned to individual people under Settings.
• Tenant scoping: tenant paths take the organisation's id (tnt_…). Another organisation's resources answer 404, never 403.
• Errors: {"detail": "…", "code": "…"} with the HTTP status. Validation errors are 422 and may add errors: [{"path": "…", "message": "…"}].
• Pagination: ?page=&page_size= (default 25, maximum 100); responses are {items, total, page, page_size}.
• Ids are prefixed strings, such as tnt_, prf_, tpl_.
• Request ids: X-Request-ID is returned on every response; quote it to support.

Endpoints#

Tenant paths below start with /tenants/{t}.

Example: the calling user's signature#

1
2

curl -s "https://scailine.scailabs.ai/v1/signatures/me?compose=reply&scope=external" \
  -H "Authorization: Bearer $TOKEN"

1
2
3
4
5
6

{
  "html": "<table …>…</table>",
  "text": "Jan Jansen\nSales Engineer, ScaiLabs\n+31 45 …",
  "bundle_version": 12,
  "components_applied": ["legal"]
}

components_applied lists which separately managed parts (legal, banner) the signature contains; a client that inserts this signature sets X-ScaiLine-Client so the server does not add them a second time.

404 with code: bundle_missing means nothing has been compiled for this person yet (no rule or template applies); 503 means the signature store is briefly unavailable, so retry.