API reference

This reference is rendered from the published OpenAPI contract itself. The contract file is the single source of truth; this page has no content of its own.

Contract: Mirai Move API v1 · openapi.json · sha256 7b5f61d69207bcaba6e32fd680fc73761b7ed63cf0338e3819bebbe8afbef4d6

Authentication: every endpoint requires a bearer credential (issued under governed human approval).

Real-shaped (synthetic) response examples are also available as each product's sample JSON. See a synthetic sample JSON

get/api/v1/deliverables

Released decision documents of the credential's workspace (index)

Only deliverables in a released-or-later state whose entitlement grants API consumption to this workspace. Ordered by released_at desc. Drafts are never listed.

Parameters

limit (query, integer)
cursor (query, string) — the next_cursor of the previous page (a released_at timestamp)

Responses

200 (index) · 401 · 403 · 429

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/deliverables

get/api/v1/deliverables/{deliverableId}

One released document

Default: the current released version. ?version=n returns exactly version n; a version that is not released returns 404, never a silent substitution. A foreign id returns 404 (indistinguishable from missing).

Parameters

deliverableId (path, required, string)
version (query, integer)

Responses

200 (document) · 401 · 403 · 404 · 429

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/deliverables/<deliverableId>

get/api/v1/deliverables/{deliverableId}/versions

Released version history of one deliverable

Parameters

deliverableId (path, required, string)

Responses

200 (versions) · 404

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/deliverables/<deliverableId>/versions

get/api/v1/cases

Cases you are authorized to read

Responses

200 (index)

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/cases

get/api/v1/cases/{caseId}

One Case at your permission depth

Parameters

caseId (path, required, string)

Responses

200 (case) · 404

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/cases/<caseId>

get/api/v1/evidence

Evidence passages of an authorized Case

Parameters

caseId (query, string)

Responses

200 (evidence)

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/evidence

get/api/v1/matches

Current match evaluations of an authorized Case

Responses

200 (matches)

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/matches

get/api/v1/solution-gaps

Solution gaps of an authorized Case

Responses

200 (gaps)

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/solution-gaps

get/api/v1/monitoring

Aggregate platform health and freshness of your authorized Cases

Responses

200 (monitoring)

Example call

curl -H "Authorization: Bearer $MIRAI_MOVE_TOKEN" \
  https://www.miraimove.com/api/v1/monitoring

Schemas

Envelope · Refusal · Statement · Section · Bilingual · DeliverableDocument · DeliverableSummary

Back to Developers