Search documentation

Search across all documentation pages

Get API Key

REST API

Integrate Zenode's component intelligence into your own workflows via HTTPS and JSON.

Introduction

What the API offers, how to authenticate, and where to start reading.

View section

Start with API overview, or browse all guides below.

Quickstart

Short paths to your first API call.

View section

Start with Make your first call, or browse all guides below.

Concepts

Identifiers, errors, usage billing, and API conventions.

View section

Start with Identifiers & slugs, or browse all guides below.

Endpoints

Every API endpoint — what it does, how to call it, and what it returns.

View section

Start with Conventions, or browse all guides below.

Conventions

Base URL, versioning, request and response format, methods, and how result lists are bounded.

Part matching

Resolve partial or messy part numbers to canonical Zenode parts — one at a time, or a whole BOM in a single request.

Part Catalog search

Search the catalog by query and parametric filters, returning compact part summaries (free) — plus a facets endpoint for building filter UIs.

Part detail

Fetch the full record for one part — specs, pricing, datasheets, and regulatory data — by its manufacturer and MPN slug.

Manufacturers

Resolve a manufacturer name to a canonical slug, and fetch a full manufacturer record by slug.

Categories

Resolve a category name to a canonical path slug, browse the category tree, and fetch a category by slug.

AI part discovery

Describe what you need in plain language; Zenode's AI returns the best parts to choose from, each with a rationale.

AI deep dive

Ask Zenode's AI one or more questions about a specific part and get formatted, cited answers.

AI alternates

Find replacement parts for a component and compare the best of them side by side with the original, datasheet against datasheet.

Async AI jobs

AI endpoints run as asynchronous jobs — create one, then poll or stream the same job for both progress and the final result.

Usage

Read your current billing-period consumption across the metering classes — part records and AI tokens.

Approved-parts lists

List your approved-parts lists (AVLs) and Zenode-curated lists, and get the list_id you scope searches to.

Reference

The structure of every object the API returns.

View section

Start with PartSummary, or browse all guides below.

PartSummary

The compact part shape returned by the match endpoints.

PartDetail

The full part record — a superset of PartSummary with specs, packaging, pricing, datasheets, lifecycle, and regulatory data.

PartFilters

The shared filter object used by catalog search and its facets.

Spec

A single parametric specification on a part.

Packaging

Physical package and supplier packaging for a part — package type, pin count, and supplier pack quantities.

DistributorOffer

A distributor's current offer for a part, with its quantity-break price ladder.

Datasheet

A datasheet for a part, linking to the Zenode-hosted document page.

Regulatory

Regulatory, compliance, and trade-classification attributes for a part.

PartStatus

A part's lifecycle status, as a stable lowercase string.

Lifecycle

Lifecycle and obsolescence detail for a part — status date and comments, EOL estimates, last-time-buy, and risk ratings.

Manufacturer

The manufacturer objects — the lightweight ManufacturerRef embedded in parts, and the fuller Manufacturer record.

Category

The category objects — the CategoryRef embedded in parts, the CategoryNode used to browse the tree, and the fuller Category detail record.

Job

The asynchronous job object that AI endpoints create, plus its compact JobSummary list form.

Answer

One deep-dive deliverable's result — a formatted value with an explanation and citations.

Citation

A cited source backing an AI answer, linking to the Zenode page that shows it.

ResponseFormat

Controls the shape of a deep-dive answer — text, number, enum, list, or JSON.

DiscoverPick

One AI-discovery result — a part plus the rationale for why it fits.

DiscoverResult

The result payload of a completed discovery job — an overall summary plus the ranked picks.

DeepDiveResult

The result payload of a completed deep-dive job — one answer per requested deliverable.

AlternatesResult

The result payload of a completed alternates job — the original part and its ranked, compared replacements.

Alternate

One candidate replacement for a part — its identity, how far the search got with it, and, once compared, the side-by-side comparison with the original.