Endpoints reference
Every endpoint with method, path, access, parameters and examples.
Generated from the route table the API dispatches on: every endpoint listed here is one the server answers, and nothing else is.
Registry
- GET/api/v1/industriesList industries. Industries with a published schema.Public
- GET/api/v1/industries/:keyGet an industry schema. The published schema of one industry: primitives with layer and parameters, connection types and modules.Public
- GET/api/v1/searchSearch the registry. Search System Atlas: registry companies (name, domain, industry, coverage, claimed), industries and segments, primitives of published schemas, constructs and glossary terms; with a key also your workspaces, companies and components. Typo-tolerant and ranked. Filters can be written in the query (industry:staffing region:US layer:software type:company,primitive claimed:yes) or passed as parameters.Public
- GET/api/v1/glossaryGet the glossary. Every term System Atlas uses, grouped into sections, with definitions and allowed values.Public
Workspaces and research
- GET/api/v1/workspacesList workspaces. The workspaces your key can reach.Needs a key
- GET/api/v1/workspaces/:slugGet a workspace. Its companies and how much of each is mapped, the client's layer health and the top gaps.Needs a key
- GET/api/v1/workspaces/:slug/companies/:companyGet a company atlas. Components with values, confidence and sources, the edges between them and notes. Add public=1 for the outsider view.Needs a key
- GET/api/v1/workspaces/:slug/compareCompare companies. The client against competitors, one row per primitive, biggest differences first.Needs a key
- GET/api/v1/workspaces/:slug/research/:runGet a research run. Progress and result of a research run: status, pages read, components and values written, cost.Needs a key
- GET/api/v1/workspaces/:slug/mapping-guideGet the mapping guide. The upload contract: parts of the business, primitives, parameters, flow types, limits and instructions.Needs a key
- POST/api/v1/workspaces/:slug/companiesAdd a competitor. Add a competitor with its website to a workspace, so it can be researched.Needs a key
- POST/api/v1/workspaces/:slug/companies/:company/researchStart research. Start the research agent on a company. Returns the run; poll Get a research run.Needs a key
- GET/api/v1/workspaces/:slug/screenshotsList screenshots. Screenshots of a company you can see, newest first, with tier, verified flag, component and image URL.Needs a key
- GET/api/v1/workspaces/:slug/draftsList drafts. Drafts waiting for review: research findings and agent uploads not yet confirmed, with evidence quote, source and origin, plus outside contributions with their trust score. 50 a page.Needs a key
Your workspace and uploads
- POST/api/v1/workspacesCreate your workspace. Create, or find by company name, your private workspace for your own company. Idempotent.Write · editor key
- POST/api/v1/workspaces/:slug/upload/componentsUpload components. Up to 200 components per call. Each is placed on a primitive and stored private, self-reported, draft.Write · editor key
- POST/api/v1/workspaces/:slug/upload/flowsUpload flows. Hand-offs between components, by component id, clientId or label.Write · editor key
- POST/api/v1/workspaces/:slug/upload/notesUpload notes. Comments and the operating reality: workarounds, bottlenecks, manual hand-offs. Duplicates are skipped.Write · editor key
- POST/api/v1/workspaces/:slug/upload/screenshotUpload a screenshot. One screenshot of the company's software (PNG, JPEG or WebP, up to 5 MB; base64 or an https URL). Metadata is stripped; it is placed on the matching component and stored private and unverified. The same image twice is skipped.Write · editor key
- POST/api/v1/workspaces/:slug/drafts/reviewReview drafts. Confirm, reject or make private drafts by id. Ids the key cannot see are skipped. Contributions need the company owner's key.Write · editor key
- POST/api/v1/contributionsContribute facts. Offer facts about a company you do not own, each with a source URL and a quote from that page. Each is scored for trust; 75+ appears on the public profile as a draft the company can reject.Write · editor key
- POST/api/v1/proposalsPropose a primitive. Propose a primitive the industry's schema does not have yet, with public sources and quotes copied from them. Reviewed by the System Atlas team; proposing the same thing again adds sources.Write · editor key
- POST/api/v1/workspaces/:slug/optimal-engine/sendSend to Optimal Engine. Send company maps to the workspace's connected cloud Optimal Engine as evidence and pending claims.Write · editor key
- POST/api/v1/workspaces/:slug/optimal-engine/pullPull from Optimal Engine. Import the connected cloud engine's facts about a company as private drafts.Write · editor key
- GET/api/v1/workspaces/:slug/optimal-engine/exportExport for a local Optimal Engine. The documents to POST to a local engine's /api/ingest yourself.Write · editor key
- POST/api/v1/workspaces/:slug/optimal-engine/importImport from a local Optimal Engine. Pass the claims you read from your local engine; claims about the company land as drafts.Write · editor key
Registry authoring (admin)
- GET/api/v1/admin/registry/guideRegistry authoring guide. The contract for writing System Atlas records, and an industry's baseline schema with ?industry=.Admin
- POST/api/v1/admin/registry/organizationsUpsert a registry organization. Creates or updates the public registry organization for a domain (one per domain).Admin
- POST/api/v1/admin/registry/componentsUpsert registry components. Up to 200 public components with values, each on an open-web source. Re-sending a clientId updates it.Admin
- POST/api/v1/admin/registry/flowsUpsert registry flows. Up to 200 public flows between an organization's components.Admin
- POST/api/v1/admin/registry/notesUpsert registry notes. Up to 200 notes and operating-reality findings on an organization or its components.Admin
- POST/api/v1/admin/registry/gapsUpsert registry gaps. Up to 200 gaps: what an organization has that no primitive of its schema covers.Admin
- POST/api/v1/admin/registry/taxonomyUpsert taxonomy nodes. Up to 200 sectors, industries and segments by key.Admin
- POST/api/v1/admin/registry/schemasUpsert an industry schema. Primitives, parameters and connection types by key, into a new version that is published unless publish is false.Admin