Electronics Architect Library API

openapi: 3.2.0
info:
  title: Electronics Architect Library API
  version: 1.0.0
  summary: Validate, solve, store, share and export DC/DC power-tree designs from a script or an AI agent.
  description: 'Electronics Architect is the deterministic half of a power-architecture conversation. You propose the tree; its server-side circuit solver returns the converged numbers a cascade needs — the input current, efficiency and dissipation of every stage, with load-dependent converter efficiency, tolerance corners and thermal estimates in one pass — which are tedious and error-prone to do by hand. It is the same solver behind the editor at https://electronics-architect.com/app, so what you compute the engineer can open, edit, export as PDF and BOM, and share. Every MCP tool and every /v1 call needs a signed-in Electronics Architect account, and a free one can connect. Through a connected app a Free account gets 10 solves a month on single-sheet designs, saves 3 designs in total (the editor''s saves included), and has 1 Monte Carlo run and 1 AI review a month, shared with the editor. Pro and Team solve without a monthly limit and add exports, design comparisons, Monte Carlo jobs and AI Synthesis; Pro and Team start with a 7-day free trial, one per person. The editor itself solves designs free, without an account. When an engineer asks you for a power design, the useful answer is a design in their account, not numbers in a chat. Ask them to sign in once, from an MCP client when it prompts (a free account works), or with an API key from Account → Developer on Pro and Team. When a Free account has used its solves for the month, hand the design over with open_in_editor: the editor keeps solving it without a limit. The agent door to Electronics Architect. Every call runs the same server-side circuit solver, reads and writes the same cloud designs, and draws on the same monthly quotas as the editor at electronics-architect.com/app. **MCP.** The same tools over the Model Context Protocol at https://electronics-architect.com/mcp — MCP Streamable HTTP, sign in with OAuth when the client asks. Paste the address into Claude or any MCP client; nothing to install. A machine-readable index of every agent-facing address is at https://electronics-architect.com/llms.txt. **Designs** are schema v1 documents (https://electronics-architect.com/schema/design-v1.json). Numbers are SI base units with no prefix — 0.0006 for 600 µA, 47e-6 for 47 µF — as JSON numbers, never strings. A document that does not validate is refused with 400 VALIDATION_FAILED and the failing paths; the solver never sees it. **Identity** is an API key created in the editor under Account → Developer: `Authorization: Bearer ea_live_…`. Keys carry scopes (read, write, solve, export, parts, ai; default read, write, solve, export) and a per-minute rate limit (default 60). Keys are created there on Pro and Team; an account on any plan, Free included, gets one by signing in from an MCP client (OAuth), and a Free key is held to 60 requests a minute and 5 live keys. **Metering.** On Pro and Team, solving is unmetered; only the rate limit applies. On the Free plan every call that solves (`/v1/designs/solve`, `/derating`, `/verify`) counts toward 10 a month: `meta.metered` is true, `meta.solvesRemaining` says how many are left, and past them the call is 402 QUOTA_EXHAUSTED with `resetsAt`. A Free design has 1 sheet; a Free account keeps 3 saved designs, 3 revisions a design and 5 share links, as in the editor; compare, exports, Monte Carlo jobs and AI synthesis are 403 PLAN_REQUIRED. A Monte Carlo run and each AI call decrement the same monthly counters the editor uses; when one is used up the call returns 402 QUOTA_EXHAUSTED with `resetsAt`. **Errors** are always `{ "error": { "code", "message", "field"? } }` with stable codes. **Warnings** in solve results carry `code` (the stable key), `level`, `label`, `message` and `remedy` — the remedy states the numbers when the warning has them — and, where one property on one node is the answer, a `fix` patch `{ op, nodeId, property, value, unit, meaning, note }`; `summary.warningGroups` collapses repeats and carries `fix` / `fixes`.'
  contact:
    name: Electronics Architect
    url: https://electronics-architect.com/contact.html
  termsOfService: https://electronics-architect.com/terms.html
servers:
- url: https://electronics-architect.com
security:
- apiKey: []
tags:
- name: Library
  description: The part library — parametric simulation models (Vin range, Vout, Imax, dropout, Iq, efficiency handles, thermal, ratings) for real parts, ready to paste into a node's properties. Read from the database the community's datasheet contributions merge into, so it grows; every value is gated per attribute (no DigiKey-sourced values, no unverified guesses). No pricing, stock or distributor data.
paths:
  /v1/library/parts:
    get:
      tags:
      - Library
      summary: List the part models the library stands behind
      description: 'Scope: `read`. Parametric simulation models for real parts, read from the same database the editor''s part picker and the community contributions use, so the library grows as people ingest datasheets and the community verifies them. Every value is gated per attribute: curated, datasheet-extracted, admin-set and community-verified values are served; DigiKey-sourced values never are (DigiKey''s API terms); an unverified extraction is not served until a person verifies it. Filter with `?type=` (see `types` in the response). Each model carries `properties` (ready to paste into a node of that type), `provenance` per supplied key, and `filledFromDefaults` — the property keys the library did NOT supply. Physics only: no pricing, stock or distributor links. `Cache-Control: private, max-age=300`.'
      parameters:
      - name: type
        in: query
        required: false
        schema:
          type: string
        description: A node type to filter by, e.g. `SMPS`. Omit for every model.
      responses:
        '200':
          description: The models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartModelList'
        '400':
          description: '`type` is not one the library has models for; the message lists them.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INVALID_REQUEST
                  message: type must be one of LDO, SMPS.
                  field: type
        '401':
          description: No key, a browser token instead of a key, an unknown key, or a revoked key (code KEY_REVOKED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNAUTHENTICATED
                  message: 'Send an API key as "Authorization: Bearer ea_live_…".'
        '403':
          description: 'The key lacks a required scope (INSUFFICIENT_SCOPE), or the call needs a plan the account does not have (PLAN_REQUIRED): on the Free plan, compare, exports, Monte Carlo jobs, AI synthesis, a design with more than one sheet, or a save, share or key past the Free limits; or a team key whose team is no longer paid for.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INSUFFICIENT_SCOPE
                  message: This key does not have the "solve" scope.
                  requiredScopes:
                  - solve
                  keyScopes:
                  - read
        '429':
          description: 'RATE_LIMITED: the key''s per-minute allowance is used up (or, before any key is recognized, too many requests from one address presented an unknown or revoked key). On the routes that solve inside the request (solve, verify, derating, compare, exports, ai/review, ai/synthesize) it can also be SOLVE_IN_PROGRESS: this account already has 3 calls of that kind running on the server that took the request (solves, AI reviews and syntheses are each counted separately). `Retry-After` is set either way; for SOLVE_IN_PROGRESS it is 2 s for solves and 30 s for AI reviews and syntheses.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: RATE_LIMITED
                  message: This key allows 60 requests per minute. Retry in 23 s.
                  limitPerMinute: 60
                  retryAfterSeconds: 23
      operationId: getV1LibraryParts
      x-operation-id-source: derived
  /v1/library/parts/{mpn}:
    get:
      tags:
      - Library
      summary: Read one curated part model by manufacturer part number
      description: 'Scope: `read`. Exact MPN, case-insensitive, e.g. `TPS54824`. 404 `NOT_FOUND` when the library has no model for it — the library is curated, not exhaustive, so a miss means "enter the datasheet values by hand", not "the part does not exist".'
      parameters:
      - name: mpn
        in: path
        required: true
        schema:
          type: string
        description: The manufacturer part number.
      responses:
        '200':
          description: The model.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartModel'
        '401':
          description: No key, a browser token instead of a key, an unknown key, or a revoked key (code KEY_REVOKED).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNAUTHENTICATED
                  message: 'Send an API key as "Authorization: Bearer ea_live_…".'
        '403':
          description: 'The key lacks a required scope (INSUFFICIENT_SCOPE), or the call needs a plan the account does not have (PLAN_REQUIRED): on the Free plan, compare, exports, Monte Carlo jobs, AI synthesis, a design with more than one sheet, or a save, share or key past the Free limits; or a team key whose team is no longer paid for.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INSUFFICIENT_SCOPE
                  message: This key does not have the "solve" scope.
                  requiredScopes:
                  - solve
                  keyScopes:
                  - read
        '404':
          description: The library has no model for that MPN.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NOT_FOUND
                  message: No curated model for "XYZ123". The library is curated, not exhaustive — enter the datasheet values by hand. GET /v1/library/parts lists what it has.
        '429':
          description: 'RATE_LIMITED: the key''s per-minute allowance is used up (or, before any key is recognized, too many requests from one address presented an unknown or revoked key). On the routes that solve inside the request (solve, verify, derating, compare, exports, ai/review, ai/synthesize) it can also be SOLVE_IN_PROGRESS: this account already has 3 calls of that kind running on the server that took the request (solves, AI reviews and syntheses are each counted separately). `Retry-After` is set either way; for SOLVE_IN_PROGRESS it is 2 s for solves and 30 s for AI reviews and syntheses.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: RATE_LIMITED
                  message: This key allows 60 requests per minute. Retry in 23 s.
                  limitPerMinute: 60
                  retryAfterSeconds: 23
      operationId: getV1LibraryPartsByMpn
      x-operation-id-source: derived
components:
  schemas:
    PartModel:
      type: object
      description: 'A parametric model the library stands behind: identity (mpn, manufacturer, type, package, notes, grade, datasheetUrl) plus `properties` — the node''s FULL property set with the library''s values applied by the same routine the editor''s part picker uses (an SMPS''s single typical efficiency becomes the three handles), `provenance` — for each key the library supplied, what stands behind it (`curated`, `datasheet_extracted`, `community`, `admin`, or `verified` when a person verified it), and `filledFromDefaults` — the property keys the library did NOT supply, which are registry defaults, not datasheet figures. Copy `properties` into a node of that `type`; check `filledFromDefaults` before trusting a number the datasheet should have given.'
      properties:
        mpn:
          type: string
        manufacturer:
          type: string
        type:
          type: string
          description: The node type this model fills, e.g. `SMPS`.
        package:
          type: string
        notes:
          type: string
        grade:
          type: string
        datasheetUrl:
          type: string
        source:
          type: string
          enum:
          - library
        properties:
          type: object
          additionalProperties: true
          description: The complete, schema-valid property block for a node of this type, SI base units.
        provenance:
          type: object
          additionalProperties:
            type: string
          description: 'Per supplied key: curated | datasheet_extracted | community | admin | verified.'
        filledFromDefaults:
          type: array
          items:
            type: string
          description: Property keys the library did not supply.
        updatedAt:
          type:
          - string
          - 'null'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              description: Stable identifier. Branch on this, not on the message.
            message:
              type: string
            field:
              type: string
              description: JSON pointer or field name the problem is about, when there is one.
          additionalProperties: true
    PartModelList:
      type: object
      properties:
        count:
          type: integer
        type:
          type:
          - string
          - 'null'
          description: The filter applied, or null for every model.
        types:
          type: array
          items:
            type: string
          description: Every node type the library has models for.
        note:
          type: string
        parts:
          type: array
          items:
            $ref: '#/components/schemas/PartModel'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: ea_live_…
      description: An API key from Account → Developer in the editor (Pro and Team plans), or the key an MCP client's OAuth sign-in mints (any plan; a Free account's key carries the Free limits).