Electronics Architect Compare API

openapi: 3.2.0
info:
  title: Electronics Architect Compare 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: Compare
  description: What changed between two designs and what it did — the change → compare → export loop an agent iterates. Solving both sides is unmetered; the optional Monte Carlo half is two metered runs.
paths:
  /v1/designs/compare:
    post:
      tags:
      - Compare
      summary: What changed between two designs, and what it did
      description: 'Scope: `solve`. Each side is a design document, `{ design }`, `{ designId }` (a saved design visible to this key) or `{ templateId }` — mix them freely. Both are solved at `options.corner` (unmetered) and the response lists the document diff (`changes`), the movement in source power, load power, dissipation, efficiency and warning counts (`delta`), the converters whose loss moved (`stages`), every node whose operating point moved (`nodes`) and the warnings resolved and introduced. Pass `options.monteCarlo: { trials, seed }` for a `yield` block — two Monte Carlo runs with the same seed, metered as two runs; 402 QUOTA_EXHAUSTED applies then, and only then. Pro and Team only: a Free account is refused with 403 PLAN_REQUIRED (one sentence and the trial link).'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - a
              - b
              properties:
                a:
                  description: 'The baseline: a design document, { design }, { designId } or { templateId }.'
                  oneOf:
                  - $ref: '#/components/schemas/Design'
                  - type: object
                    properties:
                      design:
                        $ref: '#/components/schemas/Design'
                      designId:
                        type: string
                      templateId:
                        type: string
                b:
                  description: The candidate, in the same forms.
                  oneOf:
                  - $ref: '#/components/schemas/Design'
                  - type: object
                    properties:
                      design:
                        $ref: '#/components/schemas/Design'
                      designId:
                        type: string
                      templateId:
                        type: string
                options:
                  type: object
                  properties:
                    corner:
                      type: string
                      enum:
                      - nom
                      - min
                      - max
                      - worst
                      default: nom
                      description: Which tolerance corner to solve. `min`/`max` push every toleranced value to its extreme. `worst` moves each one the way that raises the draw and the heat (loads up, efficiencies down, a switcher's output up, an LDO's down) and holds the input at nominal; each sheet's `worstCase.held` lists what it held and why.
                    ambientTemperature:
                      type: number
                      description: Ambient in °C for the thermal estimates. Defaults to the design's own setting, else 25.
                    monteCarlo:
                      type: object
                      description: Add a yield comparison. Two metered runs.
                      properties:
                        trials:
                          type: integer
                          minimum: 1
                          default: 200
                        seed:
                          type: integer
      responses:
        '200':
          description: The comparison.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompareResponse'
        '400':
          description: VALIDATION_FAILED on either side, or a malformed side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INVALID_REQUEST
                  message: 'a is required: a design document, { design }, { templateId } or { designId }.'
                  field: a
        '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_…".'
        '402':
          description: QUOTA_EXHAUSTED — only when `options.monteCarlo` is given.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: QUOTA_EXHAUSTED
                  message: The monthly monte carlo quota for this account is used up (10/10).
                  feature: monte_carlo
        '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: NOT_FOUND — a designId or templateId on either side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NOT_FOUND
                  message: No design with id "x" is visible to this key.
                  field: a.designId
        '413':
          description: PAYLOAD_TOO_LARGE.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: PAYLOAD_TOO_LARGE
                  message: 'Design a: too many nodes.'
        '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: postV1DesignsCompare
      x-operation-id-source: derived
components:
  schemas:
    Delta:
      type: object
      description: '{ a, b, delta } — delta is b − a, null when either side is missing.'
      properties:
        a:
          type:
          - number
          - 'null'
        b:
          type:
          - number
          - 'null'
        delta:
          type:
          - number
          - 'null'
    CompareSide:
      type: object
      description: One side of a comparison as solved.
      properties:
        source:
          type: string
          description: '"design", "design:<id>" or "template:<id>".'
        name:
          type:
          - string
          - 'null'
        designHash:
          type: string
        converged:
          type: boolean
        totalSourcePower:
          type:
          - number
          - 'null'
        totalLoadPower:
          type:
          - number
          - 'null'
        totalDissipation:
          type:
          - number
          - 'null'
        efficiency:
          type:
          - number
          - 'null'
        warnings:
          type: object
          properties:
            total:
              type: integer
            critical:
              type: integer
            warning:
              type: integer
            caution:
              type: integer
            info:
              type: integer
    Design:
      $ref: https://electronics-architect.com/schema/design-v1.json
      description: Design schema v1, generated from the attribute registry and published at https://electronics-architect.com/schema/design-v1.json.
    CompareResponse:
      type: object
      properties:
        a:
          $ref: '#/components/schemas/CompareSide'
        b:
          $ref: '#/components/schemas/CompareSide'
        changes:
          type: object
          description: The document diff, layout ignored.
          properties:
            nodes:
              type: object
              properties:
                added:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      type:
                        type: string
                removed:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      type:
                        type: string
                changed:
                  type: array
                  items:
                    type: object
                    description: 'id, name, type, then only the parts that differ: `properties` (key → { from, to }), `part` ({ from, to } MPN), `typeChange`, `nameChange`, `tolerances`, `portDirections`.'
            connections:
              type: object
              properties:
                added:
                  type: array
                  items:
                    type: object
                removed:
                  type: array
                  items:
                    type: object
            identical:
              type: boolean
        delta:
          type: object
          properties:
            totalSourcePower:
              $ref: '#/components/schemas/Delta'
            totalLoadPower:
              $ref: '#/components/schemas/Delta'
            totalDissipation:
              $ref: '#/components/schemas/Delta'
            efficiency:
              $ref: '#/components/schemas/Delta'
            warnings:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/Delta'
        nodes:
          type: array
          description: Every node present in both whose voltage, current, power or junction temperature moved by more than 1e-9.
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              type:
                type: string
              voltage:
                $ref: '#/components/schemas/Delta'
              current:
                $ref: '#/components/schemas/Delta'
              power:
                $ref: '#/components/schemas/Delta'
              temperature:
                $ref: '#/components/schemas/Delta'
        stages:
          type: array
          description: Converters whose dissipation or efficiency moved.
          items:
            type: object
            properties:
              nodeId:
                type: string
              name:
                type: string
              type:
                type: string
              pdiss:
                $ref: '#/components/schemas/Delta'
              eff:
                $ref: '#/components/schemas/Delta'
        warnings:
          type: object
          properties:
            resolved:
              type: array
              items:
                type: object
            introduced:
              type: array
              items:
                type: object
        yield:
          type: object
          description: 'Only with options.monteCarlo: trials, thermalViolationRate, protectionTripRate, failedTrials, efficiencyMean, efficiencyP1, powerMean, powerP99 — each a Delta.'
          additionalProperties:
            $ref: '#/components/schemas/Delta'
        meta:
          type: object
          properties:
            schemaVersion:
              type: integer
            corner:
              type: string
            ambientTemperature:
              type:
              - number
              - 'null'
            metered:
              type: boolean
            feature:
              type: string
            monteCarlo:
              type: object
            elapsedMs:
              type: number
            release:
              type: string
    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
  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).