Aegis

Aegis Workspace

Developer

Checking session...
AegisAegis Developer Portal

Developer Search

Press ⌘K or Ctrl+K to jump through guides and API endpoint docs.

API Reference

Aegis Platform API

Connect RPC surface for the Aegis zero-knowledge platform. Operations are tagged as `public` (integrator-facing) or `private` (internal/elevated).

Browse available API operations, inspect request and response contracts, and copy code samples to build integrations quickly.

Developer Home

Explore APIs

Use this explorer to find endpoint contracts, payload shapes, and runnable code samples for integration.

Open First Endpoint

How to Consume APIs

  1. Authenticate your caller and obtain an access token.
  2. Pick an endpoint and confirm the request schema in the endpoint page.
  3. Send `Authorization: Bearer ...` and `Content-Type: application/json` headers.
  4. Parse the response body and handle standard error codes before retrying.
  5. Validate your flow in sandbox and E2E before production rollout.
curl -X POST "$API_BASE/aegis.v1.IdentityGatewayService/CreateSession" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"dev@company.com","password":"<redacted>"}'

For endpoint-specific examples in multiple languages, open any endpoint detail page from the explorer.

Request Checklist

Keep requests simple and explicit to reduce integration errors.

  • Use one token per caller session and rotate on sign-out or incident.
  • Include only required fields for the operation you are calling.
  • Treat `invalid_argument` and `permission_denied` as non-retryable.
  • Use exponential backoff for transient failures like `unavailable`.