Execute a Circuit

The sample code below illustrates executing a circuit by referring to its unique circuit ID and passing key-value pairs as the input to the circuit in the form of a dictionary.

To know more about the component instance circuit_service used below, please refer to this help section.

Parameters Used

Parameter Name Data Type Definition
circuit ID Numeric A Mandatory parameter. Will store the unique ID the circuit to be executed.
circuit input Object A Mandatory parameter. Will store the dictionary that contains the input to the cricut.
copy
#Execute a circuit
circuit = app.circuit()
result = circuit.execute(5249000000108030, name="Test_Circuit")

A sample response is shown below :

copy
{
   "id":"5249000000108030",
   "name":"Test_Circuit",
   "start_time":"Aug 18, 2021 07:35 PM",
   "status":"running",
   "status_code":1,
   "execution_meta":{

}, “circuit_details”:{ “name”:“Test_Circuit”, “ref_name”:“testcircuit”, “description”:"", “instance_id”:“70454fc5-3bf6-45af-81ca-2742cc049698” }, “input”:{ “name”:“Aaron Jones” } }

Info : Refer to the SDK Scopes table to determine the required permission level for performing the above operation.

Last Updated 2025-03-28 18:24:49 +0530 IST