Skip to main content
Kyberis supports two machine authentication modes.

API Key Credentials

Most investigation endpoints accept API key credentials:
Keep API key secrets out of prompts, logs, screenshots, and committed files.

Short-lived Bearer Tokens

Mint a bearer token from API key credentials:
Use the token on bearer-protected endpoints:
Bearer token responses include expiry, scopes, audiences, issuer, principal ID, and token type. Rotate back to API key credentials when a bearer expires instead of storing bearer tokens long term.
Machine bearer tokens minted from API keys are not console session tokens. Use the Kyberis dashboard to create, list, update, or delete API keys; the /v2/api-keys management endpoints require a console login session and do not accept API keys or machine bearer tokens.

Scopes

Different endpoints require different scopes. Common examples: A missing scope returns 403 with error_code="insufficient_scope" and required_scopes.

Agent context

All investigation POST calls should include agent_context.
Allowed workflow stages are resolve, evidence, relationships, assessment, hunt, hydrate, batch, finalize, and other. You can include optional agent_context.skill to identify the executing skill:
Set id to 1–128 characters. If you provide version, use 1–64 characters; both values reject control characters. Skill metadata is self-reported and does not verify installation or outcomes. You can omit skill without changing existing requests. See Intelligence flow for recorded transport, agent, and skill attribution.

Hydration Headers

GET /v2/entities/{canonical_id} and GET /v2/evidence/{evidence_id} use headers for agent context:

Request Correlation

Send X-Request-ID when you need cross-system tracing. Kyberis responses include X-Request-ID; error bodies also include request_id.