Skip to main content

API Reference

Complete reference for the pycredoai SDK.

Resources

Core Resources

ResourceDescription
ModelsModels management
Policy Control BasesPolicy Control Bases management
Policy ControlsPolicy Controls management
Policy PacksPolicy Packs management
QuestionnairesQuestionnaires management
Risk ScenariosRisk Scenarios management
Risk TypesRisk Types management
Use CasesUse Cases management
VendorsVendors management
Workflow StagesWorkflow Stages management

System

ResourceDescription
HealthHealth checks
SystemSystem checks

Data Types

Request and response schemas used by the SDK.

CategoryDescription
Use Case TypesUse Case schemas
Model TypesModel schemas
Vendor TypesVendor schemas
Questionnaire TypesQuestionnaire schemas
Policy Pack TypesPolicy Pack schemas
Policy Control TypesPolicy Control schemas
Risk TypesRisk schemas
Workflow TypesWorkflow schemas
Common TypesCommon schemas

Quick Example

from credoai import CredoAI

client = CredoAI()

# List use cases
for uc in client.use_cases.list_all():
print(f"{uc.id}: {uc.name}")

# Create a use case
from credoai import UseCaseCreate

new_uc = client.use_cases.create(
data=UseCaseCreate(name="My Use Case")
)