Create Circuit

POST 
/api/v1/circuit/create

Create a circuit.

Request

multipart/form-data

Body

required

files binary[]required
tags string[]

Default value: latest

Tags for a circuit.

Responses

201

Created

application/json

Schema

Schema

oneOf

BoojumCircuitInfoResponse

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.

CircomCircuitInfoResponse

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: [circom]

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.

curve Curve (string)required

The elliptic curve over which the proving protocol takes place.

num_constraints Num Constraints (integer)

The number of constraints in the Rank-1 Constraint System (R1CS) of the circuit.

num_outputs Num Outputs (integer)

The number of public outputs from the circuit.

num_private_inputs Num Private Inputs (integer)

The number of private inputs for the circuit.

num_public_inputs Num Public Inputs (integer)

The number of public inputs for the circuit.

Halo2CircuitInfoResponse

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: [halo2]

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.

class_name Class Name (string)required

The path to the circuit struct definition. This is specified during creation in the included sindri.json file.

curve Curve (string)required

The elliptic curve over which the proving protocol takes place.

degree Degree (integer)required

The log_2 of the number of rows in the circuit, expressed as a matrix.

halo2_version Halo2 Version (string)required

The Halo2 frontend version tag.

GnarkCircuitInfoResponse

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: [gnark]

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.

curve Curve (string)required

The elliptic curve over which the proving protocol takes place.

gnark_version Gnark Version (string)required

The Gnark frontend version tag.

NoirCircuitInfoResponse

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: [noir]

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.

acir_opcodes Num ACIR Opcodes (integer)

The number of opcodes in the intermediate representation.

circuit_size Circuit Size (integer)

The number of constraints with an instantiated proving backend in the circuit.

curve Curve (string)required

The elliptic curve over which the proving protocol takes place.

nargo_package_name Nargo Package Name (string)required

The name of the circuit project specified in the included Nargo.toml file.

noir_version Noir Version (string)required

The Noir frontend version tag.

Example (from schema)

{}

412

Precondition Failed

application/json

Schema

Schema

error Error (string)required
message Message (string)

Default value: Invalid upload.

Example (from schema)

{
  "error": "string",
  "message": "Invalid upload."
}

422

Unprocessable Entity

application/json

Schema

Schema

location Location (string)required
message Message (string)required

Example (from schema)

{
  "location": "string",
  "message": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error Error (string)required
message Message (string)

Default value: An internal error occurred.

Example (from schema)

{
  "error": "string",
  "message": "An internal error occurred."
}

501

Not Implemented

application/json

Schema

Schema

message Message (string)

Default value: Coming soon!

Example (from schema)

{
  "message": "Coming soon!"
}

Loading...