Reference

API reference documentation.

Complete reference documentation for Risicare APIs.

Overview

Python SDK

SDK API reference

Learn more

REST API

HTTP API reference

Learn more

Quick Links

SDK

import risicare
from risicare import SemanticPhase
 
# Core
risicare.init(api_key="rsk-...")
risicare.flush()                       # -> bool
risicare.shutdown()
 
# Decorators
@risicare.agent(name=..., role=...)
@risicare.session(session_id_arg="session_id", user_id_arg="user_id")
@risicare.trace_think
@risicare.trace_decide
@risicare.trace_act
@risicare.trace_message(target=..., target_name=...)
@risicare.trace_delegate(target=..., target_name=...)
 
# Context Managers
risicare.session_context(session_id, user_id=...)
risicare.agent_context(agent_id, agent_name=..., agent_role=...)
risicare.phase_context(SemanticPhase.THINK)
risicare.restore_trace_context(ctx)    # ctx: a TraceContext

REST API

During the beta an API key can call the routes below. The Management API is not available with an API key — see REST API.

# Ingest gateway — https://ingest.risicare.ai
POST   /v1/spans
POST   /v1/spans/batch
POST   /v1/traces
POST   /v1/otlp/v1/traces

# Scores — https://api.risicare.ai
POST   /v1/scores