Skip to main content
GitHub

Reference

API reference documentation.

Complete reference documentation for Risicare APIs.

Overview

SDK

import risicare
 
# Core
risicare.init(api_key, ...)
risicare.flush()
risicare.shutdown()
 
# Decorators
@risicare.agent(name, role, ...)
@risicare.session(session_id, user_id, ...)
@risicare.trace_think
@risicare.trace_decide
@risicare.trace_act
@risicare.trace_message(sender, receiver, ...)
@risicare.trace_delegate(delegator, delegate, ...)
 
# Context Managers
risicare.session_context(session_id, user_id, ...)
risicare.agent_context(name, role, ...)
risicare.phase_context(phase)
risicare.restore_trace_context(trace_context)

REST API

# Traces
GET    /v1/traces
GET    /v1/traces/{trace_id}

# Sessions
GET    /v1/sessions
GET    /v1/sessions/{session_id}

# Agents
GET    /v1/agents
GET    /v1/agents/{agent_id}

# Diagnoses
GET    /v1/diagnoses
GET    /v1/diagnoses/{diagnosis_id}
POST   /v1/diagnoses

# Fixes
GET    /v1/fixes
GET    /v1/fixes/{fix_id}
POST   /v1/fixes
PATCH  /v1/fixes/{fix_id}

# Deployments
GET    /v1/deployments
GET    /v1/deployments/{deployment_id}
POST   /v1/deployments
DELETE /v1/deployments/{deployment_id}

# Admin
GET    /v1/projects
PATCH  /v1/projects/{project_id}
GET    /v1/api-keys
POST   /v1/api-keys
DELETE /v1/api-keys/{key_id}

Authentication

All API requests require authentication:

curl -X GET "https://app.risicare.ai/v1/traces" \
  -H "Authorization: Bearer rsk-..."

Base URLs

EnvironmentURL
Productionhttps://app.risicare.ai
Staginghttps://api.staging.risicare.ai

Rate Limits

EndpointFreeProEnterprise
Ingestion1K/min10K/minCustom
Query100/min1K/minCustom

Response Format

All responses use JSON:

{
  "data": { ... },
  "meta": {
    "request_id": "req-abc123",
    "timestamp": "2024-01-15T10:00:00Z"
  }
}

Error responses:

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: project_id",
    "details": { ... }
  }
}

Pagination

Cursor-based pagination:

GET /v1/traces?limit=50&cursor=eyJpZCI6ImFiYyJ9

Response includes next cursor:

{
  "data": [...],
  "meta": {
    "next_cursor": "eyJpZCI6Inh5eiJ9",
    "has_more": true
  }
}

Next Steps