Skip to documentation

Hyran DataDocsAPI v1

API status Open console

Start

Getting started
Make the first authenticated request.
Authentication
Use tenant-bound credentials and scopes.

Data guides

Entity graph
Search and traverse governed entities.
BOM yields
Read snapshots, yields, and temporal changes.
Pagination and filters
Follow opaque cursors and bounded filters.
Exports
Create and download asynchronous CSV exports.

Operate

Errors and rate limits
Recover safely from bounded failures.
MCP
Connect bounded tools over Streamable HTTP.
API reference
Inspect the canonical OpenAPI operations.
Changelog
Track public contract changes.

Browse documentation

Start

Getting started
Authentication

Data guides

Entity graph
BOM yields
Pagination and filters
Exports

Operate

Errors and rate limits
MCP
API reference
Changelog

HTTP 500internal_error

Internal service error

Hyran Data could not complete the request safely.

Recovery

Retry only when retryable is true. Preserve the request ID and provide it to Hyran support if the problem persists.

Preserve the response request ID when contacting Hyran support. Never include the API credential in a ticket, screenshot, or log.

Hyran Data API v1. Public documentation contains no customer data.

Changelog OpenAPI JSON