Skip to content

api

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
__init__.py
__init__.py
 
 
app.py
app.py
 
 

README.md

CircuitMind API

Developer: Alia
Module: REST API Server — connects all 4 CircuitMind modules

What It Does

This FastAPI server connects all 4 modules (Generate, Explain, Diagnose, Export) into a single running service. Any frontend, tool, or script can send requests to this API and get circuit results back.

Endpoints

Method Endpoint Description
GET / Health check — confirms API is running
POST /generate Convert natural language prompt to circuit JSON
POST /explain Explain a circuit in plain English
POST /diagnose Check circuit for electrical issues
POST /export Export circuit to SPICE netlist or SVG
POST /generate-and-explain Generate + explain + diagnose in one request

Setup

1. Install dependencies

pip install -r requirements.txt

2. Add API key

cp .env.example .env

Open .env and add your Groq API key. Get a free key at console.groq.com.

GROQ_API_KEY=your_key_here

3. Run the server

uvicorn api.app:app --reload

4. Open interactive docs

http://localhost:8000/docs

Example Requests

Generate a circuit

POST /generate
{
  "prompt": "make me a LED circuit"
}

Response:

{
  "circuit_name": "LED Circuit",
  "components": ["battery", "resistor", "led"],
  "connections": ["battery -> resistor -> led"],
  "confidence": "high",
  "source": "llm"
}

Explain a circuit

POST /explain
{
  "circuit_json": {
    "circuit_name": "LED Circuit",
    "components": ["battery", "resistor", "led"],
    "connections": ["battery -> resistor -> led"]
  }
}

Diagnose a circuit

POST /diagnose
{
  "circuit_json": {
    "circuit_name": "Bad Circuit",
    "components": ["battery", "led"],
    "connections": ["battery -> led"]
  }
}

Export to SPICE

POST /export
{
  "circuit_json": {
    "circuit_name": "LED Circuit",
    "components": ["battery", "resistor", "led"],
    "connections": ["battery -> resistor -> led"]
  },
  "export_format": "spice"
}

All in one

POST /generate-and-explain
{
  "prompt": "555 timer circuit"
}

Files

File Purpose
app.py Main FastAPI server code
README.md This file