Vendors
Manage vendors in Credo AI.
Related Resources
| Resource | Description |
|---|---|
| Use Cases | Vendors Use Cases relationships |
| Models | Vendors Models relationships |
| Questionnaires | Vendors Questionnaires relationships |
Methods
create
Create Vendor Create a new vendor.
This endpoint creates a new vendor in the Credo AI vendor registry.
- Python
- TypeScript
from credoai import VendorCreate
data = VendorCreate(
name="Example Name",
)
response = client.vendors.create(
data=data,
)
const { data, error } = await client.vendors.create({
name: 'Example Name',
});
Parameters:
data(VendorCreate, required) - Request payload
Returns: Response object
list
List Vendors List all vendors.
This endpoint retrieves all vendors with optional pagination. Returns a paginated response with items and pagination metadata.
- Python
- TypeScript
response = client.vendors.list()
const { data, error } = await client.vendors.list();
Parameters:
page_limit(Any, optional) - Query parameterpage_after(Any, optional) - Query parameter
Returns: Response object
get
Get Vendor Get a vendor by ID.
This endpoint retrieves an existing vendor by its ID.
- Python
- TypeScript
vendor_id = "vendor_id-123"
response = client.vendors.get(
vendor_id=vendor_id,
)
const vendorId = 'vendor_id-123';
const { data, error } = await client.vendors.get(vendorId);
Parameters:
vendor_id(str, required) - Resource identifier
Returns: Response object
update
Update Vendor Update an existing vendor.
This endpoint updates an existing vendor with the provided data. Only the fields provided in the request will be updated.
- Python
- TypeScript
from credoai import VendorUpdate
vendor_id = "vendor_id-123"
data = VendorUpdate(
name="Example Name",
)
response = client.vendors.update(
vendor_id=vendor_id,
data=data,
)
const vendorId = 'vendor_id-123';
const { data, error } = await client.vendors.update(
vendorId,
{ name: 'Example Name' },
);
Parameters:
vendor_id(str, required) - Resource identifierdata(VendorUpdate, required) - Request payload
Returns: Response object
delete
Delete Vendor Delete a vendor by ID.
This endpoint deletes an existing vendor by its ID.
- Python
- TypeScript
vendor_id = "vendor_id-123"
response = client.vendors.delete(
vendor_id=vendor_id,
)
const vendorId = 'vendor_id-123';
const { data, error } = await client.vendors.delete(vendorId);
Parameters:
vendor_id(str, required) - Resource identifier
Returns: Response object
Error Handling
- Python
- TypeScript
from credoai.errors import ApiError, ClientValidationError
from credoai.auth import AuthenticationError
try:
response = client.vendors.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}")
const { data, error } = await client.vendors.create({
name: 'Example Name',
});
if (error) {
console.error(`API error ${error.status}:`, error.body);
}