Covalent Cloud API

Welcome to the Covalent Cloud SDK API documentation. This section will guide you through the key functions that our SDK provides.

Account Management

cc.save_api_key

Writes or overwrites the API key in the credentials config file.

cc.get_api_key

Retrieves the API key from the credentials config file.

Secret Management

cc.store_secret

Stores a new secret in the user's account.

cc.delete_secret

Deletes a secret in the user's account.

cc.list_secrets

Retrieves all stored secrets in the user's account.

Execution Environment

cc.create_env

Creates a re-usable software environment for tasks and services.

Compute Resources

cc.CloudExecutor

Specifies a set of compute resources (like GPUs, vCPUs, and memory) for tasks and services.

Persistent Storage

cc.volume

Creates a named cloud volume for persistent storage.

Workflow Decorators

@ct.electron

Converts a function to a cloud-executable task.

@ct.lattice

Converts a function composed of electron calls to a cloud-executable workflow.

Service Decorator

@cc.service

Decorates a function that defines the initializer of a long-running service.

Execution

cc.deploy

Deploys a Covalent function service.

cc.get_deployment

Loads and/or refreshes a client for a deployed function service.

cc.dispatch

Dispatches a workflow for execution.

cc.get_result

Retrieves the result of a workflow.