Policy Control Bases

Manage policy control bases in Credo AI.

Related Resources

Resource	Description
Versions	Policy Control Bases Versions relationships

Methods

list

List Policy Control Bases List all custom policy control bases.

Returns a paginated list of policy control bases defined by the tenant.

Python

response = client.policy_control_bases.list()

TypeScript

const { data, error } = await client.policyControlBases.list();

Parameters:

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

Returns: Response object

---

create

Create Policy Control Base Create a new custom policy control base.

Creates a new policy control base that can have versions attached to it.

Python

from credoai import PolicyControlBaseCreate

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

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

TypeScript

const { data, error } = await client.policyControlBases.create({
  name: 'Example Name',
});

Parameters:

• data (PolicyControlBaseCreate, required) - Request payload

Returns: Response object

---

get

Get Policy Control Base Get a specific policy control base by ID.

Returns the details of a custom policy control base.

Python

base_id = "base_id-123"

response = client.policy_control_bases.get(
    base_id=base_id,
)

TypeScript

const baseId = 'base_id-123';

const { data, error } = await client.policyControlBases.get(baseId);

Parameters:

• base_id (str, required) - The policy control base ID

Returns: Response object

---

update

Update Policy Control Base Update an existing policy control base.

Updates the specified policy control base. Currently supports archiving.

Python

from credoai import PolicyControlBaseUpdate

base_id = "base_id-123"

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

response = client.policy_control_bases.update(
    base_id=base_id,
    data=data,
)

TypeScript

const baseId = 'base_id-123';

const { data, error } = await client.policyControlBases.update(
  baseId,
  { name: 'Example Name' },
);

Parameters:

• base_id (str, required) - The policy control base ID
• data (PolicyControlBaseUpdate, required) - Request payload

Returns: Response object

---

delete

Delete Policy Control Base Delete a policy control base.

Deletes the specified policy control base and all associated versions.

Python

base_id = "base_id-123"

response = client.policy_control_bases.delete(
    base_id=base_id,
)

TypeScript

const baseId = 'base_id-123';

const { data, error } = await client.policyControlBases.delete(baseId);

Parameters:

• base_id (str, required) - The policy control base ID

Returns: Response object

---

Error Handling

Python

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

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

TypeScript

const { data, error } = await client.policyControlBases.create({
  name: 'Example Name',
});

if (error) {
  console.error(`API error ${error.status}:`, error.body);
}