Skip to main content
POST /api/generate proxies to POST /api/v3/components/generate/symbol. The backend runs the AI agent; the route validates input and maps the response to camelCase. Requires a bearer token and a plan that includes generation.

​
Request

​
Authorization
string
required
Bearer <access_token>
​
description
string
required
5–5000 characters.
​
datasheet_url
string
Optional datasheet to ground generation.
​
additional_instructions
string
Optional layout/pin hints.

​
Response — GenerateSymbolResult

​
success
boolean
​
symbolName
string
From backend name.
​
kicadSym
string | null
Rendered .kicad_sym (backend kicad_sym).
​
pinCount
number
From pin_count.
​
reference
string
Reference prefix, e.g. U (from reference_prefix).
​
pins
Array<{ number, name, type }>
​
footprint_filters
string[]
​
traceJson
object
The structured TraceSymbolV1 payload (used for clipboard/save).
​
steps
Array<{ step, status, duration_ms, warnings }>
​
keywords / description / datasheet / warning
…

​
Example

curl -X POST https://symbols.buildwithtrace.com/api/generate \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{"description":"ATmega328P MCU, 28-pin DIP with SPI, I2C, UART"}'

​
Errors

StatusMeaning
400Description too short/long
401Missing/expired token
402 / 403Plan/quota does not include generation
504Generation timed out
502Backend error
AI-generated symbols are a starting point. Always verify pin names, numbers, and types against the datasheet before using a generated symbol in a real design.
After a successful generation you can copy or download the .kicad_sym, or save it to the user’s account.