Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kyberis.ai/llms.txt

Use this file to discover all available pages before exploring further.

Kyberis supports two machine authentication modes.

​
API key credentials

Most investigation endpoints accept API key credentials: 
Authorization: ApiKey <key_id>:<secret>
Keep API key secrets out of prompts, logs, screenshots, and committed files.

​
Short-lived bearer tokens

Mint a bearer token from API key credentials: 
curl -sS -X POST "https://api.kyberis.ai/v2/auth/token" \
  -H "Authorization: ApiKey <key_id>:<secret>" \
  -H "Accept: application/json"
Use the token on bearer-protected endpoints: 
Authorization: Bearer <access_token>
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.

​
Scopes

Different endpoints require different scopes. Common examples:
ScopeUsed for
read:resolutionEntity resolution and entity hydration
read:evidenceEvidence retrieval and evidence hydration
read:relationshipsRelationship pivots
read:intelGeneral intelligence search
read:prioritizeEnvironment-aware ranking
read:assessmentsDeterministic assessment endpoints
batch:*Batch variants of the read endpoints
A missing scope returns 403 with error_code="insufficient_scope" and required_scopes.

​
Agent context

All investigation POST calls should include agent_context. 
{
  "agent_context": {
    "objective": "Determine whether this alert is actionable.",
    "requested_outcome": "Return evidence-backed guidance.",
    "workflow_stage": "assessment",
    "run_id": "run-20260527-001",
    "step_id": "step-03"
  }
}
Allowed workflow stages are resolve, evidence, relationships, assessment, hydrate, batch, finalize, and other.

​
Hydration headers

GET /v2/entities/{canonical_id} and GET /v2/evidence/{evidence_id} use headers for agent context: 
X-Agent-Objective: Hydrate the entity for final reporting.
X-Agent-Requested-Outcome: Return bounded detail.
X-Agent-Workflow-Stage: hydrate
X-Agent-Run-ID: run-20260527-001
X-Agent-Step-ID: step-04

​
Request correlation

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