> ## Documentation Index > Fetch the complete documentation index at: https://docs.amlok.io/llms.txt > Use this file to discover all available pages before exploring further. # Simulate a change in a run > Simulate a change in a run. Affects only resources owned by this run. Funding is synthetic and requires Owner billing authority. Receipt changes publish new normalized data versions. Evaluation advances the selected monitor to its next evaluation immediately without changing server time, token expiry or billing periods. resume\_credits clears the explicit insufficient-credit test condition after simulated funding. See [Sandbox scenarios](https://docs.amlok.io/api-reference/sandbox-journeys.md) for permissions, fixture coverage, expected results, delivery controls and limitations. The autopay payment outcome tests a synthetic balance of CAD 199 against a CAD 200 threshold, creating a CAD 1,000 simulated top-up. It does not change saved auto-pay settings or deduct funds to force the actual Sandbox balance below the threshold. Source changes require connections:write; evaluation requires signal:write; credit recovery requires insights:write and Owner billing authority. Examples use synthetic IDs. Replace them with values returned by your environment. ## OpenAPI ````yaml openapi/amlok.json POST /v1/sandbox/runs/{id}/actions openapi: 3.1.0 info: title: AMLOK API version: 1.0.0 description: >- AMLOK API: borrower connections, Insights origination, immutable risk packages and Signal monitoring. Use your institution-issued API origin. servers: [] security: - BearerAuth: [] tags: - name: Sandbox description: Reproducible developer scenarios with synthetic data and money. paths: /v1/sandbox/runs/{id}/actions: post: tags: - Sandbox summary: Simulate a change in a run description: >- Affects only resources owned by this run. Funding is synthetic and requires Owner billing authority. Receipt changes publish new normalized data versions. Evaluation advances the selected monitor to its next evaluation immediately without changing server time, token expiry or billing periods. resume_credits clears the explicit insufficient-credit test condition after simulated funding. See [Sandbox scenarios](/api-reference/sandbox-journeys) for permissions, fixture coverage, expected results, delivery controls and limitations. The autopay payment outcome tests a synthetic balance of CAD 199 against a CAD 200 threshold, creating a CAD 1,000 simulated top-up. It does not change saved auto-pay settings or deduct funds to force the actual Sandbox balance below the threshold. Source changes require connections:write; evaluation requires signal:write; credit recovery requires insights:write and Owner billing authority. operationId: simulateSandboxAction parameters: - name: id in: path required: true schema: type: string minLength: 1 - name: Idempotency-Key in: header required: true schema: type: string minLength: 1 description: >- Stable for one intended command and its retries, scoped to key workspace/environment and operation. Mismatched body returns 409. Full response replay 24 hours; durable receipt remains. - name: X-AMLOK-Sandbox-Scenario in: header required: false schema: type: string enum: - happy_path - source_reauthorization - document_required - missing_financial_input - restricted_report - provider_failure - insufficient_credits - monitoring_alert - payment_return - export_failure description: >- Sandbox-only deterministic test scenario on borrower creation, persisted for that borrower. On other operations or any Live request, reject before side effects with 400 sandbox_only. Omit for happy_path. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SimulateSandboxActionRequest' example: action: evaluate_monitor resource_id: mon_example responses: '200': description: Successful request content: application/json: schema: type: object properties: data: type: object properties: action: enum: - funding - receipts_drop - receipts_recover - evaluate_monitor - resume_credits resource_id: type: - string - 'null' status: type: string required: - action - resource_id - status additionalProperties: false meta: $ref: '#/components/schemas/Meta' required: - data - meta additionalProperties: false example: data: action: evaluate_monitor resource_id: mon_example status: queued meta: request_id: req_example schema_version: 1.0.0 environment: sandbox '400': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: validation_error message: Validation error. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '401': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: unauthenticated message: Unauthenticated. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '402': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: insufficient_credits message: Insufficient credits. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '403': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: forbidden message: Forbidden. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '404': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: not_found message: Not found. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '409': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: idempotency_conflict message: Idempotency conflict. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '410': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: cursor_expired message: Cursor expired. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '413': description: >- Request exceeds the effective profile size limit or media type is unsupported. No command is accepted. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: payload_too_large message: payload too large retryable: false request_id: req_synthetic field: null '415': description: >- Request exceeds the effective profile size limit or media type is unsupported. No command is accepted. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: unsupported_media_type message: unsupported media type retryable: false request_id: req_synthetic field: null '422': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: validation_error message: Validation error. retryable: false request_id: req_synthetic field: null headers: X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '429': description: >- Rate budget, shared in-flight limit or ready-queue limit exceeded before admission. Retry-After is mandatory in whole seconds. Preserve command identity. No accepted receipt or charge is created. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: rate_limited message: Rate limited. retryable: true request_id: req_synthetic field: null headers: Retry-After: description: Minimum delay in seconds before retry. schema: type: integer minimum: 0 X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. '503': description: >- Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After. content: application/json: schema: type: object properties: error: $ref: '#/components/schemas/Error' required: - error additionalProperties: false example: error: code: temporarily_unavailable message: Temporarily unavailable. retryable: true request_id: req_synthetic field: null headers: Retry-After: description: Minimum delay in seconds before retry. schema: type: integer minimum: 0 X-Request-ID: schema: type: string minLength: 1 description: Same request ID as meta.request_id or error.request_id. security: - BearerAuth: [] x-codeSamples: - lang: Shell label: cURL source: |- curl --request POST --fail-with-body --max-time 30 \ "${AMLOK_API_BASE_URL}/v1/sandbox/runs/record_synthetic/actions" \ --header "Authorization: Bearer ${AMLOK_API_KEY}" \ --header 'Accept: application/json' \ --header 'Idempotency-Key: simulateSandboxAction-synthetic-0042' \ --header 'Content-Type: application/json' \ --data '{"action":"evaluate_monitor","resource_id":"mon_example"}' - lang: Python source: > import os import requests headers = {'Accept': 'application/json', 'Idempotency-Key': 'simulateSandboxAction-synthetic-0042', 'Content-Type': 'application/json'} headers["Authorization"] = "Bearer " + os.environ["AMLOK_API_KEY"] response = requests.request('POST', os.environ["AMLOK_API_BASE_URL"] + '/v1/sandbox/runs/record_synthetic/actions', headers=headers, json={'action': 'evaluate_monitor', 'resource_id': 'mon_example'}, timeout=30, allow_redirects=False) response.raise_for_status() print(response.json()) - lang: JavaScript source: > const headers = {"Accept": "application/json", "Idempotency-Key": "simulateSandboxAction-synthetic-0042", "Content-Type": "application/json"}; headers.Authorization = `Bearer ${process.env.AMLOK_API_KEY}`; const response = await fetch(process.env.AMLOK_API_BASE_URL + "/v1/sandbox/runs/record_synthetic/actions", { method: "POST", headers, redirect: "error", signal: AbortSignal.timeout(30000), body: JSON.stringify({"action": "evaluate_monitor", "resource_id": "mon_example"}) }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); console.log(await response.json()); components: schemas: SimulateSandboxActionRequest: type: object properties: action: enum: - funding - receipts_drop - receipts_recover - evaluate_monitor - resume_credits description: >- Controlled Sandbox-only action. Referenced resources must belong to this run. resource_id: type: string description: Resource id for this Sandbox fixture. payment_outcome: enum: - card_success - card_declined - ach_pending - ach_settled - ach_returned - payment_refund - autopay description: >- Synthetic card, ACH, refund or auto-pay result. No real payment processor is contacted. required: - action additionalProperties: false Meta: type: object properties: request_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. schema_version: type: string minLength: 1 description: >- Schema version for Meta. Constraints, requiredness and allowed values are defined by this schema. environment: type: string enum: - sandbox - live description: >- Environment for Meta. Constraints, requiredness and allowed values are defined by this schema. required: - request_id - schema_version - environment additionalProperties: false Error: type: object properties: code: type: string enum: - validation_error - unauthenticated - forbidden - not_found - invalid_state - idempotency_conflict - insufficient_credits - precondition_failed - cursor_expired - rate_limited - temporarily_unavailable - deal_snapshot_conflict - payload_too_large - unsupported_media_type - document_rejected - processing_failed - session_expired - consent_purpose_missing - sandbox_only - scenario_not_available - idempotency_result_expired - capacity_exceeded - queue_full - queue_wait_exceeded - processing_deadline_exceeded - response_too_large - export_too_large - export_expired - invalid_export_part description: >- Code for Error. Constraints, requiredness and allowed values are defined by this schema. message: type: string minLength: 1 description: >- Message for Error. Constraints, requiredness and allowed values are defined by this schema. retryable: type: boolean description: >- Retryable for Error. Constraints, requiredness and allowed values are defined by this schema. request_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. field: anyOf: - type: string minLength: 1 - type: 'null' description: >- Field for Error. Constraints, requiredness and allowed values are defined by this schema. capacity: $ref: '#/components/schemas/CapacityErrorDetail' recovery: $ref: '#/components/schemas/LargeResponseRecovery' required: - code - message - retryable - request_id - field additionalProperties: false allOf: - if: properties: code: const: response_too_large then: required: - recovery properties: retryable: const: false - if: properties: code: enum: - capacity_exceeded - queue_full then: required: - capacity properties: retryable: const: true CapacityErrorDetail: type: object properties: group: type: string enum: - http - origination - monitoring - export reason: type: string enum: - in_flight_limit - queue_full limit: type: integer minimum: 0 maximum: 9007199254740991 description: Effective admission limit. profile_id: type: string minLength: 1 profile_version: type: string minLength: 1 required: - group - reason - limit - profile_id - profile_version additionalProperties: false LargeResponseRecovery: type: object properties: export_request: $ref: '#/components/schemas/CreateExport' summary_available: type: boolean snapshot_expires_at: anyOf: - type: string minLength: 1 format: date-time - type: 'null' data_checkpoint: anyOf: - $ref: '#/components/schemas/DataCheckpoint' - type: 'null' required: - export_request - summary_available - snapshot_expires_at - data_checkpoint additionalProperties: false description: >- Complete authorized export source captured before the failed response. Existing export scopes and source permissions still apply. Snapshot expiry is null for immutable package/record sources; create snapshot exports before expiry. CreateExport: type: object properties: kind: type: string enum: - risk_package - evidence - billing - data description: >- Kind for CreateExport. Constraints, requiredness and allowed values are defined by this schema. risk_package_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. evidence_set_id: type: string minLength: 1 description: >- Opaque identifier, authorized within the API key workspace and environment. billing_report_type: type: string enum: - usage - credits - statements - funding - rates - workload description: >- Billing report type for CreateExport. Constraints, requiredness and allowed values are defined by this schema. window: $ref: '#/components/schemas/Window' description: >- Window for CreateExport. Constraints, requiredness and allowed values are defined by this schema. format: type: string enum: - json - csv - pdf description: >- Format for CreateExport. Constraints, requiredness and allowed values are defined by this schema. data_snapshot_id: type: string minLength: 1 description: Opaque ID within the authorized workspace and environment. data_record_id: type: string minLength: 1 description: >- Exact immutable DataRecord version, alternative to data_snapshot_id for kind=data. required: - kind - format additionalProperties: false oneOf: - properties: kind: const: risk_package format: type: string enum: - json - pdf required: - risk_package_id not: anyOf: - required: - evidence_set_id - required: - billing_report_type - required: - window - required: - data_snapshot_id - required: - data_record_id title: Risk-package export - properties: kind: const: evidence format: type: string enum: - json - csv required: - evidence_set_id not: anyOf: - required: - risk_package_id - required: - billing_report_type - required: - window - required: - data_snapshot_id - required: - data_record_id title: Evidence export - properties: kind: const: billing format: type: string enum: - json - csv required: - billing_report_type - window not: anyOf: - required: - risk_package_id - required: - evidence_set_id - required: - data_snapshot_id - required: - data_record_id title: Billing export - title: Collected data export properties: kind: const: data format: type: string enum: - json - csv required: [] not: anyOf: - required: - risk_package_id - required: - evidence_set_id - required: - billing_report_type - required: - window oneOf: - required: - data_snapshot_id not: required: - data_record_id - required: - data_record_id not: required: - data_snapshot_id DataCheckpoint: type: object properties: snapshot_id: type: string minLength: 1 as_of: type: string minLength: 1 format: date-time changes_cursor: type: string minLength: 1 expires_at: type: string minLength: 1 format: date-time required: - snapshot_id - as_of - changes_cursor - expires_at additionalProperties: false description: >- Atomic data snapshot and feed boundary retained even when the first record exceeds the response limit. Window: type: object properties: start: type: string minLength: 1 format: date-time description: >- Start for Window. Constraints, requiredness and allowed values are defined by this schema. end: type: string minLength: 1 format: date-time description: >- End for Window. Constraints, requiredness and allowed values are defined by this schema. required: - start - end additionalProperties: false description: UTC interval [start, end). The server rejects end <= start. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API key description: >- Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.