{ "openapi": "3.1.0", "info": { "title": "HALTSEAL Execute API Candidate", "version": "0.1.0-rc.3", "description": "Local evaluation contract. No public hosted service, qualified native AI cost boundary, or live checkout. Stable business keys identify one operation; transport uncertainty must never trigger provider fallback." }, "servers": [ { "url": "http://127.0.0.1:8787", "description": "Local evaluation only" } ], "paths": { "/v1/executions": { "post": { "operationId": "createExecution", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Execution" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExecution" } } } }, "deprecated": true, "description": "Legacy regression fixture only; disabled in default CLI. Use /v1/business-executions." } }, "/v1/executions/lookup": { "get": { "operationId": "lookupExecution", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Execution" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "scope_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } }, { "name": "operation_key", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/executions/{execution_id}": { "get": { "operationId": "getExecution", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Execution" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "execution_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/scopes/{scope_id}": { "get": { "operationId": "getScope", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Scope" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "scope_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/executions/{execution_id}/cancel": { "post": { "operationId": "cancelExecution", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Execution" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 0 } } } }, "parameters": [ { "name": "execution_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/executions/{execution_id}/resume": { "post": { "operationId": "resumeExecution", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Execution" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 0 } } } }, "parameters": [ { "name": "execution_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/executions/{execution_id}/receipt": { "get": { "operationId": "getReceipt", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "execution_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/billing/checkout": { "post": { "operationId": "createTestCheckout", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "mode" ], "properties": { "url": { "type": "string", "format": "uri" }, "mode": { "const": "test" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "request_key" ], "properties": { "request_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } } } } } } }, "/v1/billing/usage": { "get": { "operationId": "getUsage", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "unique_protected_attempts", "mode", "live_invoicing" ], "properties": { "unique_protected_attempts": { "type": "integer", "minimum": 0 }, "mode": { "const": "evaluation" }, "live_invoicing": { "const": false } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/billing/portal": { "post": { "operationId": "createTestPortal", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "mode" ], "properties": { "url": { "type": "string", "format": "uri" }, "mode": { "const": "test" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 0 } } } } } }, "/ready": { "get": { "operationId": "getReadiness", "security": [], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/health": { "get": { "operationId": "getHealth", "security": [], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/businesses": { "post": { "operationId": "approveBusiness", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Business" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceApproval" } } } } } }, "/v1/businesses/{business_id}": { "get": { "operationId": "getBusiness", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Business" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "business_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/businesses/{business_id}/aliases": { "post": { "operationId": "aliasBusiness", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "scope_alias": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "business_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "scope_alias" ], "properties": { "scope_alias": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } } } } }, "parameters": [ { "name": "business_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } }, "/v1/business-executions": { "post": { "operationId": "executeBusiness", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Execution" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessExecution" } } } } } }, "/v1/executions/{execution_id}/recover": { "post": { "operationId": "recoverExecution", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Current durable state. Business HOLD is a successful API response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Execution" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Role or entitlement required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Tenant-scoped resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting identity or exposed execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "411": { "description": "Content-Length required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Request too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "JSON required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unsupported operation or invalid cost cap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable or unqualified; execution outcome may be unknown", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "Untrusted, mismatched, ambiguous or incomplete provider evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "maxProperties": 0 } } } }, "parameters": [ { "name": "execution_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" } } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } }, "schemas": { "BusinessExecution": { "type": "object", "additionalProperties": false, "required": [ "business_id", "attempt_key", "connection_id", "action", "parameters", "max_cost_micro" ], "properties": { "business_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "attempt_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "connection_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "action": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "scope_alias": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "parameters": { "type": "object" }, "max_cost_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." } } }, "SourceApproval": { "type": "object", "additionalProperties": false, "required": [ "record", "signature" ], "properties": { "record": { "type": "object", "additionalProperties": false, "required": [ "tenant", "issuer", "source_order_id", "customer_id", "schema", "approved_budget_micro", "revision", "expires_at", "status" ], "properties": { "tenant": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "issuer": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "source_order_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "customer_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "schema": { "const": "haltseal.source-approval.v1" }, "approved_budget_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "revision": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "expires_at": { "type": "integer", "minimum": 1 }, "status": { "enum": [ "APPROVED", "REVOKED" ] } } }, "signature": { "type": "string", "pattern": "^[0-9a-f]{64}$" } } }, "Business": { "type": "object", "additionalProperties": false, "required": [ "business_id", "customer_id", "source_order_id", "issuer", "revision", "approval_digest", "status", "expires_at", "balance" ], "properties": { "business_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "customer_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "source_order_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "issuer": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "revision": { "type": "integer" }, "approval_digest": { "type": "string" }, "status": { "enum": [ "APPROVED", "REVOKED" ] }, "expires_at": { "type": "integer" }, "balance": { "$ref": "#/components/schemas/Scope" } } }, "CreateExecution": { "type": "object", "additionalProperties": false, "required": [ "scope_id", "operation_key", "connection_id", "action", "parameters", "max_cost_micro" ], "properties": { "scope_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "operation_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "connection_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "action": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "parameters": { "type": "object", "additionalProperties": true }, "max_cost_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." } } }, "Execution": { "type": "object", "additionalProperties": false, "required": [ "id", "scope_id", "operation_key", "decision", "reason", "phase", "outcome", "max_cost_micro", "reserved_micro", "consumed_micro", "cancel_requested", "provider_id", "settlement", "billable_attempt", "mode" ], "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "scope_id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "operation_key": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "decision": { "type": "string", "enum": [ "ACCEPT", "HOLD", "REFUSE" ] }, "reason": { "type": "string" }, "phase": { "type": "string", "enum": [ "HELD", "PREPARED", "UNKNOWN", "SUBMITTED", "COST_PENDING", "SETTLED" ] }, "outcome": { "type": "string", "enum": [ "UNKNOWN", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED" ] }, "max_cost_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "reserved_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "consumed_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "cancel_requested": { "type": "boolean" }, "provider_id": { "type": [ "string", "null" ] }, "settlement": { "type": "string", "enum": [ "FINAL", "UNRESOLVED" ] }, "billable_attempt": { "type": "boolean" }, "mode": { "type": "string", "const": "evaluation" } } }, "Scope": { "type": "object", "additionalProperties": false, "required": [ "id", "unit", "granted_micro", "consumed_micro", "reserved_micro", "available_micro", "frozen" ], "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{0,127}$" }, "unit": { "type": "string", "const": "USD_MICRO" }, "granted_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "consumed_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "reserved_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "available_micro": { "type": "string", "pattern": "^(0|[1-9][0-9]*)$", "maxLength": 16, "description": "USD micro-units. Integer decimal string; 1000000 = USD 1. Server maximum 9000000000000000." }, "frozen": { "type": "boolean" } } }, "Error": { "type": "object", "required": [ "error", "mode" ], "properties": { "error": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" } } }, "mode": { "const": "evaluation" } } }, "Receipt": { "type": "object", "required": [ "schema", "execution", "execution_sha256", "historical_only", "permission_to_dispatch", "signature" ], "properties": { "schema": { "const": "haltseal.evaluation.receipt.v1" }, "execution": { "$ref": "#/components/schemas/Execution" }, "execution_sha256": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "historical_only": { "const": true }, "permission_to_dispatch": { "const": false }, "signature": { "type": "null" } } } } } }