Data Types

Request and response schemas used by the pycredoai SDK.

By Resource

Category	Types	Description
Use Case	UseCaseCreate, UseCaseUpdate, UseCaseResponse	Use case management
Model	ModelCreate, ModelUpdate, ModelResponse	AI model registry
Vendor	VendorCreate, VendorUpdate, VendorResponse	Vendor management
Questionnaire	QuestionnaireCreate, QuestionnaireResponse, ...	Governance questionnaires
Common	PaginationInfo, ValidationError, RelationshipAdd	Shared types

Import Example

Python

from credoai import (
    # Use case types
    UseCaseCreate,
    UseCaseUpdate,
    UseCaseResponse,

    # Model types
    ModelCreate,
    ModelUpdate,
    ModelResponse,

    # Common types
    RelationshipAdd,
)

# Create a use case
uc = UseCaseCreate(
    name="My Use Case",
    description="Example use case"
)

# Create a relationship
rel = RelationshipAdd(id="model-123")

TypeScript

import type {
  // Use case types
  UseCaseCreate,
  UseCaseUpdate,
  UseCaseResponse,

  // Model types
  ModelCreate,
  ModelUpdate,
  ModelResponse,

  // Common types
  RelationshipAdd,
} from '@credo-ai/sdk';

// Create a use case
const uc: UseCaseCreate = {
  name: 'My Use Case',
  description: 'Example use case',
};

// Create a relationship
const rel: RelationshipAdd = { id: 'model-123' };

Type Patterns

Create Types

Used when creating new resources. Contains only the fields you can set.

Python

UseCaseCreate(
    name="Required field",
    description="Optional field",
)

TypeScript

const data: UseCaseCreate = {
  name: 'Required field',
  description: 'Optional field',
};

Update Types

Used when updating existing resources. All fields are optional.

Python

UseCaseUpdate(
    description="Only update description",
)

TypeScript

const data: UseCaseUpdate = {
  description: 'Only update description',
};

Response Types

Returned from API calls. Contains all fields including server-generated ones.

Python

response = client.use_cases.get(use_case_id="uc-123")
print(response.id)          # Server-generated
print(response.created_at)  # Server-generated
print(response.name)        # Your data

TypeScript

const { data } = await client.useCases.get('uc-123');
console.log(data.id);        // Server-generated
console.log(data.createdAt); // Server-generated
console.log(data.name);      // Your data