Skip to main content

Create Circuit

POST 
/api/v1/circuit/create

Create a circuit.

Request​

Body

required
    files binary[]required
    metaobject

    An arbitrary mapping of metadata keys to string values. This can be used to track additional information about the circuit such as an ID from an external system.

    property name* string
    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)requireddeprecated
    project_name Project Name (string)required

    The name of the project. This can be used in place of circuit_id for proving. This is specified during creation in the included sindri.json file. If the project is renamed, this will be the new name of the project, not the original name that was included in the 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.

    metaobjectrequired

    Metadata keys and values for the circuit that were specified at creation time.

    property name* string
    num_proofs Number of Proofs (integer)nullablerequired

    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

    tags string[]required

    Tags for the circuit.

    team Team Name (string)required

    The name of the team that owns this circuit.

    team_avatar_url Team Avatar Url (string)required

    URL for the avatar image of the team that owns this circuit.

    team_slug Team Slug (string)required

    The slug of the team that owns this circuit.

    compute_time durationnullablerequired

    Total compute time in ISO8601 format.

    compute_time_sec Compute Time Seconds (number)nullablerequired

    Total compute time in seconds.

    compute_times Compute Timesnullablerequired

    Detailed compute times for the circuit compilation.

    file_size File Size (integer)nullablerequired

    Total size of stored file(s) in bytes.

    queue_time durationnullablerequired

    Queue time in ISO8601 format.

    queue_time_sec Queue Time Seconds (number)nullablerequired

    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.

    has_smart_contract_verifier Has Smart Contract Verifier (boolean)required

    Boolean indicating whether this circuit has a smart contract verifier available.

    has_verification_key Has Verification Key (boolean)required

    Boolean indicating whether this circuit has a verification key available.

    verification_key objectnullablerequired

    The verification key of this circuit.

    warnings string[]nullablerequired

    A list of runtime warnings with UTC timestamps.

    error Error (string)nullablerequired

    The error message for a failed circuit upload.

    field Field (string)nullablerequired

    The field over which proofs take place.

    zkevm_version Zkevm Version (string)nullablerequired

    The zkSync Era zkEVM version tag.

Loading...