Skip to documentation
Hyran DataDocs
API status
Browse documentation
Generated from OpenAPI 3.1

API reference

Every operation, parameter, required scope, and response below is derived from the same typed contract used for runtime validation and the generated TypeScript client.

Entity graph

GET/v1/entitiesgraph:read
Search entities

Operation ID: searchEntities

GET/v1/entities/{entityId}graph:read
Get an entity

Operation ID: getEntity

GET/v1/entities/{entityId}/relationshipsgraph:read
Traverse entity relationships

Operation ID: listEntityRelationships

GET/v1/entity-typesgraph:read
List entity types

Operation ID: listEntityTypes

BOM history

GET/v1/bom/snapshotsbom:read
List completed BOM snapshots

Operation ID: listBomSnapshots

GET/v1/bom/yield-changesbom:read
Compare BOM yield snapshots

Operation ID: listBomYieldChanges

GET/v1/bom/yieldsbom:read
List BOM yields

Operation ID: listBomYields

Exports

POST/v1/exportsexports:create
Create an asynchronous CSV export

Operation ID: createExport

GET/v1/exports/{exportId}exports:create
Get export status

Operation ID: getExport

GET/v1/exports/{exportId}/downloadexports:create
Download a completed export during its short-lived access window

Operation ID: downloadExport

MCP

POST/mcpmcp:read
Call bounded MCP tools over stateless Streamable HTTP

Operation ID: mcp

Service

GET/health/livePublic
Check process liveness

Operation ID: getLiveness

GET/health/readyPublic
Check process and database readiness

Operation ID: getReadiness

GET/openapi.jsonPublic
Get the OpenAPI 3.1 document

Operation ID: getOpenApi