Skip to main content

Models

Manage models in Credo AI.

ResourceDescription
Use CasesModels Use Cases relationships
VendorsModels Vendors relationships
QuestionnairesModels Questionnaires relationships

Methods

create

Create Model Create a new model.

This endpoint creates a new model in the Credo AI model registry.

from credoai import ModelCreate

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

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

Parameters:

Returns: Response object


list

List Models List all models.

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

response = client.models.list(
)

Parameters:

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

Returns: Response object


get

Get Model Get a model by ID.

This endpoint retrieves an existing model by its ID.

model_id = "model_id-123"

response = client.models.get(
model_id=model_id,
)

Parameters:

  • model_id (str, required) - Resource identifier

Returns: Response object


update

Update Model Update an existing model.

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

from credoai import ModelUpdate

model_id = "model_id-123"

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

response = client.models.update(
model_id=model_id,
data=data,
)

Parameters:

  • model_id (str, required) - Resource identifier
  • data (ModelUpdate, required) - Request payload

Returns: Response object


delete

Delete Model Delete a model by ID.

This endpoint deletes an existing model by its ID.

model_id = "model_id-123"

response = client.models.delete(
model_id=model_id,
)

Parameters:

  • model_id (str, required) - Resource identifier

Returns: Response object


Error Handling

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

try:
response = client.models.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}")