Skip to main content
Mirai MoveMOBILITY INTELLIGENCE
Menu
Share a mobility issue

Developers — the Mirai Move API and SDKs

A governed, read-only API over released deliverables, Cases, evidence, matches, solution gaps and monitoring — within your credential's scopes. Write, outreach and payment functions do not exist in the contract.

What the API provides

Released decision documents of your organization's workspace (with exact-version fetch), the Cases you are authorized to read, their evidence passages, match evaluations, solution gaps, and aggregate freshness/health monitoring. All read-only.

Who it is for

Integration developers at enterprises, universities and research institutions, and embedded-intelligence customers.

Authentication model

Bearer credentials, issued only under governed human approval — there is no public self-service issuance. Credentials are organization-scoped, stored as hashes only, and carry expiry and revocation.

Scopes

Every credential carries an explicit scope list:

cases:read · evidence:read · suppliers:read · matches:read · solution-gaps:read · monitoring:read · deliverables:read

Rate behavior

A durable per-credential per-minute boundary (default 60 requests/minute). Excess is refused with HTTP 429 and Retry-After; refusals are audited too.

Data classification

Every response envelope states classification_ceiling (PUBLIC / PERMISSIONED) and record_class (REAL / SYNTHETIC_ACCEPTANCE). Synthetic data is always labeled synthetic.

Sample / synthetic environment

Under a record_class = SYNTHETIC_ACCEPTANCE credential every response is synthetic data and the envelope says so. Synthetic never mixes with real.

Errors / refusals

Refusals are typed: UNAUTHENTICATED, FORBIDDEN_SCOPE, RATE_LIMITED, NOT_FOUND, STORE_FAILED. The SDKs raise each as a typed error.

Pagination

Index endpoints use limit + cursor. The SDKs include an all-pages iteration helper.

Contract and versions

The contract is v1. A contract change ships as a new version; each SDK embeds the SHA-256 digest of the exact contract it targets.

openapi sha256: 7b5f61d69207bcaba6e32fd680fc73761b7ed63cf0338e3819bebbe8afbef4d6

API reference

Official SDKs (self-hosted distribution)

Deterministic artifacts distributed from Mirai Move itself — no external registry required. Every artifact carries its version, contract version, contract digest, checksum, license, README, examples and changelog. No credential is embedded in any artifact.

Software / Agent Package

The integration package (MM-SWP) contents, data boundary and security model are canonical in the package manifest. Inspect its structure through the synthetic sample document.

See the sample package delivery document

Security boundary

  • Authentication is a bearer credential issued under governed human approval; there is no self-service key issuance.
  • Credentials are never embedded in any artifact; every published artifact is secret-scanned as built bytes.
  • All access is read-only; write, outreach and payment functions are not part of the API contract.
  • Every request, including refusals, is audited server-side with durable rate limiting.
  • The package consumes the governed Mirai Move read API only: released deliverables, Cases, evidence, matches, solution gaps and monitoring, within the credential's scopes and classification ceiling.
  • No customer data leaves the customer's systems through the SDK beyond the API requests it makes; the SDK stores nothing.
  • No internal infrastructure, provider integration or internal source code is part of any customer package.

Request access

Credential issuance passes governed human approval. Nothing is issued from a public page.

Request a workspace / API