model-check-batches
Cancel selected model checks
Serialize cancellation with child acceptance, prevent new accepts and cancel the original accepted child. Upstream work may finish and cost money; customer cancellation does not invent a refund or abort proof.
POST
/
v1
/
model-check-batches
/
{batchId}
/
cancel
Cancel selected model checks
curl --request POST \
--url https://api.getmillwork.dev/v1/model-check-batches/{batchId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"expected_revision": 2
}
'const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expected_revision: 2})
};
fetch('https://api.getmillwork.dev/v1/model-check-batches/{batchId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"approval_count": 4503599627370495,
"approval_revision": 4503599627370495,
"approvals": [
{
"confirmed_at": "<string>",
"expires_at": "<string>",
"millwork_maximum_cents": 4503599627370495,
"plan_digest": "<string>",
"revision": 4503599627370495
}
],
"approvals_complete": true,
"batch_id": "<string>",
"binding_revision": 4503599627370495,
"connection_id": "<string>",
"counts": {
"accepted": 4503599627370495,
"blocked": 4503599627370495,
"cancelled": 4503599627370495,
"completed": 4503599627370495,
"failed": 4503599627370495,
"pending": 4503599627370495,
"unknown_paid": 4503599627370495
},
"created_at": "<string>",
"expires_at": "<string>",
"items": [
{
"approval_revision": 4503599627370495,
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"check_item_id": "<string>",
"child_operation_key": "<string>",
"execution_id": "<string>",
"execution_status": "accepted",
"millwork_fee_cents": 123,
"ordinal": 4503599627370495,
"provider_known_microusd": 4503599627370495,
"provider_maximum_microusd": 4503599627370495,
"provider_unresolved_microusd": 4503599627370495,
"receipt": "<string>",
"reconciliation": {
"actor": "<string>",
"evidence_ref": "<string>",
"evidence_sha256": "<string>",
"recorded_at": "<string>"
},
"revision": 4503599627370495,
"selection": {
"arm_id": "<string>",
"authority_id": "<string>",
"item_id": "<string>",
"observation_revision": "<string>",
"route_id": "<string>",
"snapshot_id": "<string>"
},
"state": "pending"
}
],
"limits": {
"attempts": 1,
"in_flight": 1,
"items": 20
},
"millwork_fee_cents": 123,
"plan_digest": "<string>",
"problem": {
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 123,
"title": "<string>",
"type": "<string>",
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"current_offer": {
"content_markdown": "<string>",
"display_label": "<string>",
"document_id": "<string>",
"offer_id": "<string>",
"published_url": "<string>",
"source_sha256": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "<string>"
},
"current_organization": {
"legal_entity_name": "<string>",
"profile_revision": 2
},
"detail": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"next_actions": [
{
"action": "<string>",
"actor": "<string>"
}
],
"reason": "agreement_terminated",
"reason_code": "access_unverified",
"retry_after_s": 123
},
"provider_approved_microusd": 4503599627370495,
"provider_known_microusd": 4503599627370495,
"provider_known_microusd_exact": "<string>",
"provider_unresolved_microusd": 4503599627370495,
"provider_unstarted_microusd": 4503599627370495,
"revision": 4503599627370495,
"state": "active",
"version": "byok-selected-checks/v1"
}{
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 123,
"title": "<string>",
"type": "<string>",
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"current_offer": {
"content_markdown": "<string>",
"display_label": "<string>",
"document_id": "<string>",
"offer_id": "<string>",
"published_url": "<string>",
"source_sha256": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "<string>"
},
"current_organization": {
"legal_entity_name": "<string>",
"profile_revision": 2
},
"detail": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"next_actions": [
{
"action": "<string>",
"actor": "<string>"
}
],
"reason": "agreement_terminated",
"reason_code": "access_unverified",
"retry_after_s": 123
}{
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 123,
"title": "<string>",
"type": "<string>",
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"current_offer": {
"content_markdown": "<string>",
"display_label": "<string>",
"document_id": "<string>",
"offer_id": "<string>",
"published_url": "<string>",
"source_sha256": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "<string>"
},
"current_organization": {
"legal_entity_name": "<string>",
"profile_revision": 2
},
"detail": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"next_actions": [
{
"action": "<string>",
"actor": "<string>"
}
],
"reason": "agreement_terminated",
"reason_code": "access_unverified",
"retry_after_s": 123
}Authorizations
bearerAuthsessionCookie
Organization API key for application requests.
Headers
Required string length:
1 - 200Path Parameters
Required string length:
1 - 200Body
application/json
Response
Default Response
Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Maximum array length:
20Show child attributes
Show child attributes
Required string length:
1 - 200Required range:
0 <= x <= 9007199254740991Required string length:
1 - 200Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Pattern:
^(0|[1-9][0-9]*)$Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Available options:
active, paused, completed, cancelled Available options:
byok-selected-checks/v1 ⌘I
Cancel selected model checks
curl --request POST \
--url https://api.getmillwork.dev/v1/model-check-batches/{batchId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"expected_revision": 2
}
'const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expected_revision: 2})
};
fetch('https://api.getmillwork.dev/v1/model-check-batches/{batchId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"approval_count": 4503599627370495,
"approval_revision": 4503599627370495,
"approvals": [
{
"confirmed_at": "<string>",
"expires_at": "<string>",
"millwork_maximum_cents": 4503599627370495,
"plan_digest": "<string>",
"revision": 4503599627370495
}
],
"approvals_complete": true,
"batch_id": "<string>",
"binding_revision": 4503599627370495,
"connection_id": "<string>",
"counts": {
"accepted": 4503599627370495,
"blocked": 4503599627370495,
"cancelled": 4503599627370495,
"completed": 4503599627370495,
"failed": 4503599627370495,
"pending": 4503599627370495,
"unknown_paid": 4503599627370495
},
"created_at": "<string>",
"expires_at": "<string>",
"items": [
{
"approval_revision": 4503599627370495,
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"check_item_id": "<string>",
"child_operation_key": "<string>",
"execution_id": "<string>",
"execution_status": "accepted",
"millwork_fee_cents": 123,
"ordinal": 4503599627370495,
"provider_known_microusd": 4503599627370495,
"provider_maximum_microusd": 4503599627370495,
"provider_unresolved_microusd": 4503599627370495,
"receipt": "<string>",
"reconciliation": {
"actor": "<string>",
"evidence_ref": "<string>",
"evidence_sha256": "<string>",
"recorded_at": "<string>"
},
"revision": 4503599627370495,
"selection": {
"arm_id": "<string>",
"authority_id": "<string>",
"item_id": "<string>",
"observation_revision": "<string>",
"route_id": "<string>",
"snapshot_id": "<string>"
},
"state": "pending"
}
],
"limits": {
"attempts": 1,
"in_flight": 1,
"items": 20
},
"millwork_fee_cents": 123,
"plan_digest": "<string>",
"problem": {
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 123,
"title": "<string>",
"type": "<string>",
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"current_offer": {
"content_markdown": "<string>",
"display_label": "<string>",
"document_id": "<string>",
"offer_id": "<string>",
"published_url": "<string>",
"source_sha256": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "<string>"
},
"current_organization": {
"legal_entity_name": "<string>",
"profile_revision": 2
},
"detail": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"next_actions": [
{
"action": "<string>",
"actor": "<string>"
}
],
"reason": "agreement_terminated",
"reason_code": "access_unverified",
"retry_after_s": 123
},
"provider_approved_microusd": 4503599627370495,
"provider_known_microusd": 4503599627370495,
"provider_known_microusd_exact": "<string>",
"provider_unresolved_microusd": 4503599627370495,
"provider_unstarted_microusd": 4503599627370495,
"revision": 4503599627370495,
"state": "active",
"version": "byok-selected-checks/v1"
}{
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 123,
"title": "<string>",
"type": "<string>",
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"current_offer": {
"content_markdown": "<string>",
"display_label": "<string>",
"document_id": "<string>",
"offer_id": "<string>",
"published_url": "<string>",
"source_sha256": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "<string>"
},
"current_organization": {
"legal_entity_name": "<string>",
"profile_revision": 2
},
"detail": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"next_actions": [
{
"action": "<string>",
"actor": "<string>"
}
],
"reason": "agreement_terminated",
"reason_code": "access_unverified",
"retry_after_s": 123
}{
"instance": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": 123,
"title": "<string>",
"type": "<string>",
"blockers": [
{
"action": "<string>",
"actor": "<string>",
"code": "access_unverified",
"evidence_refs": [
"<string>"
],
"message": "<string>"
}
],
"current_offer": {
"content_markdown": "<string>",
"display_label": "<string>",
"document_id": "<string>",
"offer_id": "<string>",
"published_url": "<string>",
"source_sha256": "<string>",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"version_id": "<string>"
},
"current_organization": {
"legal_entity_name": "<string>",
"profile_revision": 2
},
"detail": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
],
"next_actions": [
{
"action": "<string>",
"actor": "<string>"
}
],
"reason": "agreement_terminated",
"reason_code": "access_unverified",
"retry_after_s": 123
}