Comment on page
API Overview

Modules
​callbacks​
​cli​
​client​
​commands​
​commands.models​
​commands.prove​
​commands.reset_password​
​commands.users​
​commands.verify​
​commands.version​
​commands.versions​
​exceptions​
​frameworks​
​frameworks.cairo​
​frameworks.ezkl​
​options​
​utils​
​utils.decorators​
​utils.echo​
​utils.enums​
​utils.misc​
Classes
​client.ApiClient: Implementation of the API client to interact with core-services
​client.JobsClient: Client to interact with jobs endpoint.
​client.ModelsClient: Client to interact with models endpoint.
​client.ProofsClient: Client to interact with proofs endpoint.
​client.TranspileClient: Client to interact with users endpoint.
​client.UsersClient: Client to interact with users endpoint.
​client.VersionJobsClient: Client to interact with jobs endpoint.
​client.VersionsClient: Client to interact with versions endpoint.
​exceptions.PasswordError​
​echo.Echo: Helper class to use when printin output of the CLI.
​enums.Framework​
​enums.JobKind​
​enums.JobSize​
​enums.JobStatus​
​enums.VersionStatus​
Functions
​callbacks.debug_callback: If a call adds the --debug flag debugging mode is activated for external requests and API Clients.
​callbacks.version_callback: Prints the current version when --version flag is added to a call.
​cli.entrypoint​
​models.create: Command to create a model. Asks for the new model's information and validates the input,
​models.get: Command to create a user. Asks for the new users information and validates the input,
​models.list: Command to list all models.
​prove.prove​
​reset_password.handle_http_error: Handle an HTTP error.
​reset_password.prompt_for_input: Prompt the user for input.
​reset_password.request_reset_password_token: Request a password reset token for a given email.
​reset_password.reset_password: Reset the password for a user using a reset token.
​users.create: Command to create a user. Asks for the new users information and validates the input,
​users.login: Logs the current user into Giza. Under the hood this will retrieve the token for the next requests.
​users.me: Retrieve information about the current user and print it as json to stdout.
​users.resend_email: Command to resend verification email. Asks for the user's email and sends the request to the API
​verify.verify​
​version.version_entrypoint: Prints the current CLI version.
​versions.download: Retrieve information about the current user and print it as json to stdout.
​versions.get​
​versions.list​
​versions.transpile​
​versions.update​
​cairo.prove: Command to prove as spceific cairo program, previously converted to CASM.
​cairo.transpile: This function is responsible for transpiling a model. The overall objective is to prepare a model for use by converting it into a different format (transpiling).
​ezkl.prove​
​ezkl.setup: This function executes the setup of the model and creates the outputs, handled by Giza.
​ezkl.verify: Create a verification job.
​utils.get_response_info: Utility to retrieve information of the client response.
​decorators.auth: Check that we have the token and it is not expired before executing
Examples - Previous
Reset Your Password
callbacks
Last modified 1d ago