Skip to main content

Create Circuit

POST 

/api/v1/circuit/create

Create a circuit.

Request

Body

required
    files binary[]required
    tags string[]

    Default value: latest

    Tags for a circuit.

Responses

Created
Schema
    oneOf
    circuit_id uuid4required

    A unique identifier generated for the circuit. UUID4 format.

    circuit_name Circuit Name (string)required

    The name of a circuit. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file.

    circuit_type Circuit Type (string)required

    Possible values: [boojum]

    The development framework used to write the circuit. This is specified during creation in the included sindri.json file.

    date_created date-timerequired

    The UTC datetime the circuit was uploaded in ISO8601 format.

    num_proofs Number of Proofs (integer)required

    The number of proofs submitted for this circuit.

    proving_scheme Proving Scheme (string)required

    The proving scheme for this circuit. This is specified during creation in the included sindri.json file.

    public Public (boolean)required

    Whether the circuit is public. Public circuits can be used by any user.

    status JobStatus (string)required

    Possible values: [Queued, In Progress, Ready, Failed]

    JobStatus choices

    team User/Team (string)required

    The user/team that owns this circuit.

    compute_time time-delta

    Total compute time in ISO8601 format.

    compute_time_sec Compute Time Seconds (number)

    Total compute time in seconds.

    compute_times Compute Times

    Detailed compute times for the circuit compilation.

    file_size File Size (integer)

    Total size of stored file(s) in bytes.

    queue_time time-delta

    Queue time in ISO8601 format.

    queue_time_sec Queue Time Seconds (number)

    Queue time in seconds.

    uploaded_file_name Uploaded File Name (string)required

    The name of the uploaded circuit file. Note: the CLI and SDKs create a generic name when a directory is specified for upload.

    verification_key object

    The verification key of this circuit.

    error Error (string)

    The error message for a failed circuit upload.

    field Field (string)required

    The field over which proofs take place.

    zkevm_version Zkevm Version (string)required

    The zkSync Era zkEVM version tag.

Loading...