Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.voltai.ai/llms.txt

Use this file to discover all available pages before exploring further.

Under construction — This API surface is a temporary concept for validation. Some of the features are not implemented.
The Schematic API covers schematic file lifecycle (list, upload, processing status), design-level part and BOM access, conversational Q&A scoped to a schematic, and automated review flows. Send a JWT on every request.

​
Schematic

  • GET /schematics/ — List schematics (id, title, created_at).
  • POST /schematics/create/ — Upload a schematic file (multipart/form-data); returns schematic id and status.
  • GET /schematics/{schematic_id}/status/ — Processing status (processing, ready_for_review, error).

​
Parts and BOM

  • GET /schematics/{schematic_id}/parts/ — List parts (part numbers or designators).
  • GET /schematics/{schematic_id}/parts/{designator_id}/bounding_box/ — Bounding box for a designator.
  • GET /schematics/{schematic_id}/parts/{designator_id}/info/ — Part details by designator.
  • GET /schematics/{schematic_id}/parts/by_number/{part_number}/info/ — Part details by part number.
  • GET /schematics/{schematic_id}/bom/ — Full BOM payload.
  • GET /schematics/{schematic_id}/bom/stats/ — BOM aggregates (component count, price, active parts).

​
Chat

  • POST /schematics/{schematic_id}/chat/ — Ask about the schematic; optional designators and bounding boxes for grounding.
  • GET /schematics/{schematic_id}/chats/ — List chat session ids for the schematic.
  • GET /schematics/{schematic_id}/chats/{chat_id}/ — Chat thread status and content.

​
Review

  • POST /schematics/{schematic_id}/review/ — Start a review from a non-empty part-number list.
  • GET /schematics/{schematic_id}/reviews/ — List review ids.
  • GET /schematics/{schematic_id}/reviews/{review_id}/ — Review status and generated content.