Skip to main content

Use Cases

Manage use cases in Credo AI.

ResourceDescription
ModelsUse Cases Models relationships
VendorsUse Cases Vendors relationships
QuestionnairesUse Cases Questionnaires relationships
ControlsUse Cases Controls relationships
Policy PacksUse Cases Policy Packs relationships
Risk ScenariosUse Cases Risk Scenarios relationships
WorkflowUse Cases Workflow relationships

Methods​

create​

Create Use Case Create a new use case.

This endpoint creates a new use case using the authenticated context provided by the router-level authentication dependency. The context is resolved once at the router level and reused here.

from credoai import UseCaseCreate

data = UseCaseCreate(
    name="Example Name",
)

response = client.use_cases.create(
    data=data,
)

Parameters:

Returns: Response object

list​

List Use Cases List all use cases.

This endpoint retrieves all use cases with optional pagination. Returns a paginated response with items and pagination metadata.

response = client.use_cases.list(
)

Parameters:

  • page_limit (Any, optional) - Query parameter
  • page_after (Any, optional) - Query parameter

Returns: Response object

get​

Get Use Case Get a use case by ID.

This endpoint retrieves an existing use case by its ID.

use_case_id = "use_case_id-123"

response = client.use_cases.get(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

update​

Update Use Case Update an existing use case.

This endpoint updates an existing use case with the provided data. Only the fields provided in the request will be updated.

from credoai import UseCaseUpdate

use_case_id = "use_case_id-123"

data = UseCaseUpdate(
    name="Example Name",
)

response = client.use_cases.update(
    use_case_id=use_case_id,
    data=data,
)

Parameters:

  • use_case_id (str, required) - Resource identifier
  • data (UseCaseUpdate, required) - Request payload

Returns: Response object

delete​

Delete Use Case Delete a use case by ID.

This endpoint deletes an existing use case by its ID.

use_case_id = "use_case_id-123"

response = client.use_cases.delete(
    use_case_id=use_case_id,
)

Parameters:

  • use_case_id (str, required) - Resource identifier

Returns: Response object

Error Handling​

from credoai.errors import ApiError, ClientValidationError
from credoai.auth import AuthenticationError

try:
    response = client.use_cases.create(...)
except ApiError as e:
    print(f"API error {e.status_code}: {e.message}")
except ClientValidationError as e:
    print(f"Validation error: {e}")
except AuthenticationError as e:
    print(f"Auth error: {e}")