> ## Documentation Index > Fetch the complete documentation index at: https://docs.checkfu.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Base URL: https://api.checkfu.com. Current wire version: `2026-08-31` (`Checkfu-Version: 2026-08-31`). > Mutating HTTP requests require `Authorization: Bearer $CHECKFU_API_KEY`, `Checkfu-Version: 2026-08-31`, `Content-Type: application/json`, and `Idempotency-Key` on retriable writes. Ordinary API keys are Workspace-bound; do not send a Workspace selector header. > Core workflow: create an Agent (`POST /v1/agents`) and Environment (`POST /v1/environments`), grant `use_environment` (`POST /v1/permission-assignments`), create a Session (`POST /v1/sessions`), send events (`POST /v1/sessions/{id}/events`), stream progress (`GET /v1/sessions/{id}/events/stream`), and read the input result (`GET /v1/sessions/{id}/inputs/{input_id}/result`). > Domain model: an Agent is mutable configuration; a Session freezes its AgentVersion and Environment at creation and owns its private workspace and ordered event history. Vault stores secret credentials; Connection links an external account; ActionApproval records human approval before an action runs. > Capability status combines `audience`, `stability`, `availability`, evaluated prerequisites, and release evidence; check https://docs.checkfu.com/getting-started/status (`GET /v1/support/capabilities`) for live `available` status. # Resume an Automation > Return a paused Automation to active after fresh server-owned readiness checks. ## OpenAPI ````yaml /openapi.json post /v1/automations/{id}/resume openapi: 3.1.0 info: title: Checkfu API version: '2026-08-31' description: >- Authentication is declared per operation: API-key, runtime, or connector bearer; Automation signature; or credential-free pairing redemption. Every general Checkfu REST request requires the dated `Checkfu-Version` header (one of: 2026-08-31); the three MCP JSON-RPC transports use `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth callback carries neither Checkfu header. API keys resolve one Workspace without a request selector; authenticated responses identify it with `Checkfu-Workspace-Id`. servers: - url: https://api.checkfu.com security: - bearerAuth: [] tags: - name: organizations - name: sourceRepositories - name: tenants - name: workspaces - name: principals - name: principalGroups - name: principalAccessCredentials - name: apiKeys - name: agents - name: harnessRuntime - name: permissionAssignments - name: actionPolicies - name: files - name: memoryStores - name: modelCredentials - name: modelRoutingProfiles - name: toolSources - name: skills - name: skillSources - name: skillProposals - name: instructionProposals - name: catalog - name: concepts - name: support - name: connections - name: connectionAssignments - name: connectedRuntimes - name: fileTrees - name: collaboration - name: automationGraphs - name: automations - name: actionApprovals - name: standingApprovals - name: workloadReviewPolicies - name: usage - name: models - name: budgets - name: billing - name: sessions - name: audit - name: sessionExports - name: runs - name: runnerPools - name: transcripts - name: sessionWatches - name: sessionCapsules - name: sessionTrajectories - name: webhookEndpoints - name: integrationGateway - name: environments - name: vaults - name: apiMcp - name: a2a paths: /v1/automations/{id}/resume: post: tags: - automations summary: Resume an Automation description: >- Return a paused Automation to active after fresh server-owned readiness checks. Unknown or blocked dependencies refuse activation. A cron schedule starts at its next occurrence and does not backfill paused ticks. Ordinary calls may omit expected_version; when supplied it must match, including an already-active target. The server captures one observed version before the existing atomic transition. Accepts an optional Idempotency-Key; retry the same original body and key. Checkfu support posture: alpha; hosted. Required evidence journey: automation-firing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. operationId: automations.resumeAutomation parameters: - name: id in: path schema: $ref: '#/components/schemas/AutomationId' required: true - name: checkfu-version in: header schema: type: string enum: - '2026-08-31' required: true - name: idempotency-key in: header schema: type: string maxLength: 255 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/TransitionAutomation' required: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PublicAutomation_6' headers: checkfu-workspace-id: description: The Workspace resolved from the authenticated bearer credential. required: true schema: $ref: '#/components/schemas/WorkspaceId' '400': description: Typed Checkfu wire error content: application/json: schema: $ref: '#/components/schemas/ValidationMalformedError' '401': description: Typed Checkfu wire error content: application/json: schema: type: object properties: type: type: string enum: - error error: type: object properties: type: type: string enum: - authentication_error code: type: string enum: - auth.invalid_key message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-invalid-key description: >- Stable public documentation and remedy for this error type. required: - type - code - message - more additionalProperties: false request_id: type: string minLength: 1 required: - type - error - request_id additionalProperties: false '403': description: >- The organization, tenant, or workspace backing this key is administratively disabled. | Deployment governance or retention policy denied the request. content: application/json: schema: anyOf: - type: object properties: type: type: string enum: - error error: type: object properties: type: type: string enum: - permission_error code: type: string enum: - auth.disabled_tenancy message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-disabled-tenancy description: >- Stable public documentation and remedy for this error type. required: - type - code - message - more additionalProperties: false request_id: type: string minLength: 1 required: - type - error - request_id additionalProperties: false - $ref: '#/components/schemas/PolicyDeniedError' '404': description: >- The requested resource does not exist in the resolved deployment boundary. content: application/json: schema: $ref: '#/components/schemas/ValidationNotFoundError' '409': description: >- The request conflicts with the resource's current state. | An idempotent mutation conflicts with a completed or in-progress request for the same key. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationConflictError' - $ref: '#/components/schemas/IdempotencyConflictError' '429': description: Typed Checkfu wire error headers: retry-after: description: >- Delay in seconds for rate limits or deployment quotas with a known release or UTC reset boundary required: false schema: type: integer minimum: 1 content: application/json: schema: type: object properties: type: type: string enum: - error error: type: object properties: type: type: string enum: - rate_limit_error code: type: string enum: - budget.exceeded message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#budget-exceeded description: >- Stable public documentation and remedy for this error type. required: - type - code - message - more additionalProperties: false request_id: type: string minLength: 1 required: - type - error - request_id additionalProperties: false '500': description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. content: application/json: schema: $ref: '#/components/schemas/RuntimeInternalError' '503': description: >- The MemoryStore backend cannot serve the operation and applied no write. content: application/json: schema: $ref: '#/components/schemas/MemoryBackendUnavailableError' security: - bearerAuth: [] components: schemas: AutomationId: type: string pattern: ^auto_[0-9a-f]{32}$ TransitionAutomation: type: object properties: expected_version: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 additionalProperties: false PublicAutomation_6: type: object properties: type: type: string enum: - automation authoring_state: $ref: '#/components/schemas/Union_356' draft_revision: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 published_definition_revision: $ref: '#/components/schemas/Union_357' readiness: $ref: '#/components/schemas/Union_358' id: $ref: '#/components/schemas/AutomationId' workspace_id: $ref: '#/components/schemas/WorkspaceId' version: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 name: type: string minLength: 1 maxLength: 255 description: $ref: '#/components/schemas/Union_359' external_id: $ref: '#/components/schemas/Union_360' created_by: $ref: '#/components/schemas/PrincipalId' environment_id: $ref: '#/components/schemas/EnvironmentId' connected_runtime: $ref: '#/components/schemas/Union_361' metadata: $ref: '#/components/schemas/ResourceMetadata_2' status: $ref: '#/components/schemas/Union_335' archived_at: $ref: '#/components/schemas/Union_363' last_session_id: $ref: '#/components/schemas/Union_364' last_run_id: $ref: '#/components/schemas/Union_365' created_at: type: string updated_at: type: string service_principal_id: $ref: '#/components/schemas/PrincipalId' agent: $ref: '#/components/schemas/Union_366' initial_events: $ref: '#/components/schemas/Arrays_37' resources: $ref: '#/components/schemas/Arrays_38' vault_ids: $ref: '#/components/schemas/Arrays_39' budget: $ref: '#/components/schemas/Union_374' budget_policy: $ref: '#/components/schemas/SessionBudgetRequest' session_target: $ref: '#/components/schemas/AutomationAgentSessionTarget' schedule: $ref: '#/components/schemas/Union_375' paused_reason: $ref: '#/components/schemas/Union_376' steps: $ref: '#/components/schemas/AutomationStepGroups' program: $ref: '#/components/schemas/AutomationStepDagDataflow' trigger: anyOf: - $ref: '#/components/schemas/Objects_294' - type: object properties: type: type: string enum: - subscription agent_placement_id: $ref: '#/components/schemas/AgentPlacementId' source: anyOf: - type: object properties: type: type: string enum: - conversation conversation: $ref: '#/components/schemas/Union_417' resource_type: false external_id: false required: - type - conversation additionalProperties: false - type: object properties: type: type: string enum: - resource resource_type: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ external_id: type: string minLength: 1 maxLength: 512 conversation: false required: - type - resource_type - external_id additionalProperties: false cron: false timezone: false dedupe_key: false filter: false required: - type - agent_placement_id - source additionalProperties: false - type: object properties: type: type: string enum: - any sources: anyOf: - type: array prefixItems: - $ref: '#/components/schemas/Union_418' - $ref: '#/components/schemas/Objects_297' maxItems: 2 minItems: 2 - type: array prefixItems: - $ref: '#/components/schemas/Objects_297' - $ref: '#/components/schemas/Union_418' maxItems: 2 minItems: 2 required: - type - sources additionalProperties: false input_template: $ref: '#/components/schemas/AutomationPrompt' flow_review: type: object properties: model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ tier: $ref: '#/components/schemas/Union_174' criteria: $ref: '#/components/schemas/UniqueFlowReviewCriteria_3' required: - model_routing_profile_key - criteria additionalProperties: false delivery_screen: anyOf: - type: object properties: model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ tier: $ref: '#/components/schemas/Union_174' instructions: type: string minLength: 1 maxLength: 4096 failure: $ref: '#/components/schemas/Union_383' required: - model_routing_profile_key - instructions additionalProperties: false - type: object properties: evaluation: $ref: '#/components/schemas/Objects_251' rule: $ref: '#/components/schemas/Union_386' failure: $ref: '#/components/schemas/Union_383' required: - evaluation - rule additionalProperties: false draft: $ref: '#/components/schemas/AutomationBlockDraft' live_version: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' required: - type - authoring_state - draft_revision - published_definition_revision - readiness - id - workspace_id - version - name - description - external_id - created_by - environment_id - connected_runtime - status - archived_at - last_session_id - last_run_id - created_at - updated_at - service_principal_id - agent - initial_events - resources - vault_ids - budget - schedule - paused_reason additionalProperties: false WorkspaceId: type: string pattern: ^wrkspc_[0-9a-f]{32}$ ValidationMalformedError: type: object properties: error: type: object properties: type: type: string enum: - invalid_request_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-malformed description: Stable public documentation and remedy for this error type. code: type: string enum: - validation.malformed required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: >- The request could not be decoded or violated a declared input constraint. PolicyDeniedError: type: object properties: error: type: object properties: type: type: string enum: - permission_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#policy-denied description: Stable public documentation and remedy for this error type. code: type: string enum: - policy.denied required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: Deployment governance or retention policy denied the request. ValidationNotFoundError: type: object properties: error: type: object properties: type: type: string enum: - not_found_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-not-found description: Stable public documentation and remedy for this error type. code: type: string enum: - validation.not_found required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: >- The requested resource does not exist in the resolved deployment boundary. ValidationConflictError: type: object properties: error: type: object properties: type: type: string enum: - conflict_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-conflict description: Stable public documentation and remedy for this error type. code: type: string enum: - validation.conflict required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: The request conflicts with the resource's current state. IdempotencyConflictError: anyOf: - $ref: '#/components/schemas/ValidationIdempotencyConflictError' - $ref: '#/components/schemas/ValidationIdempotencyInProgressError' description: >- An idempotent mutation conflicts with a completed or in-progress request for the same key. RuntimeInternalError: type: object properties: error: type: object properties: type: type: string enum: - api_error message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#runtime-internal description: Stable public documentation and remedy for this error type. code: type: string enum: - runtime.internal required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. MemoryBackendUnavailableError: type: object properties: error: type: object properties: type: type: string enum: - api_error message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#memory-backend-unavailable description: Stable public documentation and remedy for this error type. code: type: string enum: - memory.backend_unavailable required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: The MemoryStore backend cannot serve the operation and applied no write. Union_356: type: string enum: - draft - published Union_357: anyOf: - type: integer maximum: 9007199254740991 exclusiveMinimum: 0 - type: 'null' Union_358: type: string enum: - preparing - requires_action - ready - blocked Union_359: anyOf: - type: string minLength: 1 maxLength: 4096 - type: 'null' Union_360: anyOf: - type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ - type: 'null' PrincipalId: type: string pattern: ^prin_[0-9a-f]{32}$ EnvironmentId: type: string pattern: ^env_[0-9a-f]{32}$ Union_361: anyOf: - $ref: '#/components/schemas/ConnectedRuntimeId' - type: 'null' ResourceMetadata_2: type: object additionalProperties: type: string maxLength: 512 propertyNames: type: string minLength: 1 maxLength: 64 maxProperties: 16 description: at most 16 correlation pairs with keys of 1 to 64 characters Union_335: type: string enum: - active - paused Union_363: anyOf: - type: string - type: 'null' Union_364: anyOf: - $ref: '#/components/schemas/SessionId' - type: 'null' Union_365: anyOf: - $ref: '#/components/schemas/RunId' - type: 'null' Union_366: anyOf: - $ref: '#/components/schemas/ManagedAgentsAgentParams_4' - type: 'null' Arrays_37: type: array items: anyOf: - $ref: '#/components/schemas/ManagedAgentsUserMessageEventParams_1' - $ref: '#/components/schemas/AutomationInitialSystemMessageEventParams_1' maxItems: 50 Arrays_38: type: array items: anyOf: - type: object properties: type: type: string enum: - file_tree file_tree_id: $ref: '#/components/schemas/FileTreeId' mount_path: $ref: '#/components/schemas/MountPath' version_policy: $ref: '#/components/schemas/Union_367' access: $ref: '#/components/schemas/Union_368' writeback: type: 'null' required: - type - file_tree_id - mount_path - version_policy - access additionalProperties: false - type: object properties: type: type: string enum: - file_tree file_tree_id: $ref: '#/components/schemas/FileTreeId' mount_path: $ref: '#/components/schemas/MountPath' version_policy: $ref: '#/components/schemas/Union_367' access: type: string enum: - read_write writeback: $ref: '#/components/schemas/Objects_248' required: - type - file_tree_id - mount_path - version_policy - access - writeback additionalProperties: false - type: object properties: type: type: string enum: - file file_id: $ref: '#/components/schemas/FileId' mount_path: $ref: '#/components/schemas/MountPath' access: type: string enum: - read_only required: - type - file_id - mount_path - access additionalProperties: false - type: object properties: type: type: string enum: - memory_store memory_store_id: $ref: '#/components/schemas/MemoryStoreId' access: $ref: '#/components/schemas/Union_370' selection: $ref: '#/components/schemas/Union_372' instructions: type: string minLength: 1 maxLength: 4096 required: - type - memory_store_id - access additionalProperties: false Arrays_39: type: array items: $ref: '#/components/schemas/VaultId' maxItems: 50 Union_374: anyOf: - $ref: '#/components/schemas/ManagedAgentsBudgetLimit' - type: 'null' SessionBudgetRequest: type: object properties: limit: $ref: '#/components/schemas/SessionBudgetRequestSafeLimit' metric: type: string enum: - model_tokens - model_spend - session_runtime_ms - web_search_requests - total_spend required: - limit additionalProperties: false description: >- A create-time Session spending cap compiled into one session-scoped pause_session Budget. AutomationAgentSessionTarget: anyOf: - type: object properties: mode: type: string enum: - start_new required: - mode additionalProperties: false - type: object properties: mode: type: string enum: - continue_selected session: $ref: '#/components/schemas/SessionId' required: - mode - session additionalProperties: false Union_375: anyOf: - type: object properties: type: type: string enum: - cron expression: type: string timezone: type: string last_run_at: anyOf: - type: string - type: 'null' upcoming_runs_at: type: array items: type: string required: - type - expression - timezone - last_run_at - upcoming_runs_at additionalProperties: false - type: object properties: type: type: string enum: - once at: type: string next_run_at: anyOf: - type: string - type: 'null' required: - type - at - next_run_at additionalProperties: false - type: 'null' Union_376: anyOf: - type: object properties: type: type: string enum: - manual required: - type additionalProperties: false - type: object properties: type: type: string enum: - error error: type: object properties: type: $ref: '#/components/schemas/Union_336' required: - type additionalProperties: false required: - type - error additionalProperties: false - type: object properties: type: type: string enum: - runs_as_removed required: - type additionalProperties: false - type: 'null' AutomationStepGroups: type: array items: $ref: '#/components/schemas/Objects_249' minItems: 1 maxItems: 20 AutomationStepDagDataflow: type: object properties: nodes: type: array items: anyOf: - $ref: '#/components/schemas/Objects_249' - $ref: '#/components/schemas/Objects_283' minItems: 1 maxItems: 20 edges: type: array items: $ref: '#/components/schemas/Union_412' maxItems: 320 run_limits: $ref: '#/components/schemas/AutomationRunLimitsNonEmpty_3' required: - nodes - edges additionalProperties: false Objects_294: type: object properties: type: type: string enum: - webhook provider: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ mcp_events: type: boolean enum: - true dedupe_key: $ref: '#/components/schemas/Objects_295' filter: type: object properties: predicates: type: array items: $ref: '#/components/schemas/Union_380' maxItems: 32 check: anyOf: - $ref: '#/components/schemas/Objects_250' - type: object properties: evaluation: type: object properties: schema_version: type: number enum: - 1 model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ tier: $ref: '#/components/schemas/Union_174' timeout_ms: type: number minimum: 100 maximum: 30000 questions: $ref: '#/components/schemas/TypedCheckQuestions_8' required: - schema_version - model_routing_profile_key - questions additionalProperties: false rule: anyOf: - $ref: '#/components/schemas/CheckBooleanRuleThresholds_1' - $ref: '#/components/schemas/Objects_296' - $ref: '#/components/schemas/CheckScoreTailRuleThresholds_1' - type: object properties: type: type: string enum: - all rules: type: array items: anyOf: - $ref: >- #/components/schemas/CheckBooleanRuleThresholds_1 - $ref: '#/components/schemas/Objects_296' - $ref: >- #/components/schemas/CheckScoreTailRuleThresholds_1 minItems: 1 maxItems: 8 required: - type - rules additionalProperties: false failure: $ref: '#/components/schemas/Union_383' required: - evaluation - rule - failure additionalProperties: false required: - predicates additionalProperties: false verification: anyOf: - $ref: '#/components/schemas/Objects_219' - type: object properties: kind: type: string enum: - hmac header: type: string minLength: 1 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*$ description: A lowercase HTTP header name, such as x-hub-signature-256. algorithm: $ref: '#/components/schemas/Union_255' encoding: $ref: '#/components/schemas/Union_256' prefix: type: string minLength: 1 maxLength: 32 pattern: ^[\x21-\x7e]+$ separator: type: string enum: - ',' - ; - ' ' signature_field: type: string pattern: ^[A-Za-z0-9_]{1,16}$ secret_encoding: type: string enum: - text - base64 secret_prefix: type: string minLength: 1 maxLength: 32 pattern: ^[\x21-\x7e]+$ signed_payload: type: object properties: template: type: string minLength: 3 maxLength: 96 pattern: ^[\x20-\x7e]+$ timestamp: anyOf: - type: object properties: header: type: string minLength: 1 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*$ description: >- A lowercase HTTP header name, such as x-hub-signature-256. required: - header additionalProperties: false - type: object properties: signature_field: type: string pattern: ^[A-Za-z0-9_]{1,16}$ required: - signature_field additionalProperties: false timestamp_unit: type: string enum: - seconds - milliseconds tolerance_seconds: type: integer minimum: 1 maximum: 3600 required: - template additionalProperties: false required: - kind - header - algorithm - encoding additionalProperties: false - $ref: '#/components/schemas/Objects_220' - $ref: '#/components/schemas/Objects_221' cron: false timezone: false source: false required: - type - dedupe_key additionalProperties: false AgentPlacementId: type: string pattern: ^aplace_[0-9a-f]{32}$ Union_417: anyOf: - type: object properties: kind: $ref: '#/components/schemas/Union_311' root_external_id: type: string minLength: 1 maxLength: 512 thread_external_id: type: 'null' required: - kind - root_external_id - thread_external_id additionalProperties: false - type: object properties: kind: type: string enum: - thread root_external_id: type: string minLength: 1 maxLength: 512 thread_external_id: type: string minLength: 1 maxLength: 512 required: - kind - root_external_id - thread_external_id additionalProperties: false AutomationPrompt: type: string minLength: 1 maxLength: 65536 Union_174: type: string enum: - default - planning - tool_loop UniqueFlowReviewCriteria_3: type: array items: $ref: '#/components/schemas/Objects_121' minItems: 1 maxItems: 16 Union_383: type: string enum: - fail_open - fail_closed Objects_251: type: object properties: schema_version: type: number enum: - 1 model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ tier: $ref: '#/components/schemas/Union_174' timeout_ms: type: number minimum: 100 maximum: 30000 questions: $ref: '#/components/schemas/TypedCheckQuestions_7' required: - schema_version - model_routing_profile_key - questions additionalProperties: false Union_386: anyOf: - $ref: '#/components/schemas/CheckBooleanRuleThresholds' - $ref: '#/components/schemas/Objects_254' - $ref: '#/components/schemas/CheckScoreTailRuleThresholds' - type: object properties: type: type: string enum: - all rules: type: array items: anyOf: - $ref: '#/components/schemas/CheckBooleanRuleThresholds' - $ref: '#/components/schemas/Objects_254' - $ref: '#/components/schemas/CheckScoreTailRuleThresholds' minItems: 1 maxItems: 8 required: - type - rules additionalProperties: false AutomationBlockDraft: type: object properties: revision: type: integer minimum: -9007199254740991 maximum: 9007199254740991 document: $ref: '#/components/schemas/AutomationBlockDocument' problems: type: array items: $ref: '#/components/schemas/AutomationBlockProblem' warnings: type: array items: $ref: '#/components/schemas/AutomationBlockWarning' updated_at: type: string required: - revision - document - problems - warnings - updated_at additionalProperties: false ValidationIdempotencyConflictError: type: object properties: error: type: object properties: type: type: string enum: - conflict_error message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-idempotency-conflict description: Stable public documentation and remedy for this error type. code: type: string enum: - validation.idempotency_conflict required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: The Idempotency-Key is already bound to a different request. ValidationIdempotencyInProgressError: type: object properties: error: type: object properties: type: type: string enum: - conflict_error message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-idempotency-in-progress description: Stable public documentation and remedy for this error type. code: type: string enum: - validation.idempotency_in_progress required: - type - message - more - code additionalProperties: false type: type: string enum: - error request_id: type: string minLength: 1 required: - error - type - request_id additionalProperties: false description: >- An identical idempotent request is still in progress and may be retried later. ConnectedRuntimeId: type: string pattern: ^crt_[0-9a-f]{32}$ SessionId: type: string pattern: ^sess_[0-9a-f]{32}$ RunId: type: string pattern: ^run_[0-9a-f]{32}$ ManagedAgentsAgentParams_4: type: object properties: type: type: string enum: - agent id: $ref: '#/components/schemas/AgentId' version: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 required: - type - id allOf: - type: object additionalProperties: {} - propertyNames: $ref: '#/components/schemas/Union_241' propertyNames: type: string ManagedAgentsUserMessageEventParams_1: type: object properties: type: type: string enum: - user.message content: type: array items: $ref: '#/components/schemas/ManagedAgentsContentBlock' required: - type - content additionalProperties: false AutomationInitialSystemMessageEventParams_1: type: object properties: type: type: string enum: - system.message content: type: array items: $ref: '#/components/schemas/Objects_234' required: - type - content additionalProperties: false FileTreeId: type: string pattern: ^ftree_[0-9a-f]{32}$ MountPath: type: string minLength: 1 maxLength: 1024 Union_367: anyOf: - type: object properties: kind: type: string enum: - latest required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - pinned version: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 required: - kind - version additionalProperties: false - type: object properties: kind: type: string enum: - ref ref: $ref: '#/components/schemas/GitReference' required: - kind - ref additionalProperties: false Union_368: type: string enum: - read_only - read_write Objects_248: type: object properties: kind: type: string enum: - pull_request commit_message: type: string minLength: 1 maxLength: 4096 pull_request_title: type: string minLength: 1 maxLength: 256 pull_request_body: type: string maxLength: 16384 allow_workflow_changes: type: boolean enum: - true required: - kind additionalProperties: false FileId: type: string pattern: ^file_[0-9a-f]{32}$ MemoryStoreId: type: string pattern: ^memstore_[0-9a-f]{32}$ Union_370: type: string enum: - read_only - read_write Union_372: anyOf: - type: object properties: kind: type: string enum: - ref ref: $ref: '#/components/schemas/Union_158' required: - kind - ref additionalProperties: false - type: object properties: kind: type: string enum: - version version: $ref: '#/components/schemas/Union_152' required: - kind - version additionalProperties: false VaultId: type: string pattern: ^vlt_[0-9a-f]{32}$ ManagedAgentsBudgetLimit: type: object properties: type: type: string enum: - limit max_list_cost: type: object properties: amount: type: string pattern: ^[1-9][0-9]*$ currency: type: string enum: - USD required: - amount - currency additionalProperties: false required: - type - max_list_cost additionalProperties: false SessionBudgetRequestSafeLimit: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 Union_336: type: string enum: - validation.malformed - validation.prompt_integrity_review_required - validation.not_found - validation.conflict - automation.source_event_conflict - automation.original_pending - automation.original_unavailable - automation.draft_has_problems - validation.idempotency_conflict - validation.idempotency_in_progress - validation.payload_too_large - validation.range_too_large - auth.invalid_key - auth.authorization_unavailable - auth.request_admission_unavailable - auth.disabled_tenancy - policy.denied - budget.exceeded - model.no_eligible_model - model.credential_rejected - model.platform_supply_unavailable - model.platform_capacity_reached - billing.entitlement_unavailable - billing.usage_limit_reached - billing.payment_required - billing.seat_activation_unavailable - memory.not_found - memory.conflict - memory.read_only - memory.invalid_path - memory.backend_unavailable - memory.curation_failed - runtime.invalid_transition - runtime.primary_thread - retention.zdr_unsupported - retention.evidence_content_unavailable - runtime.checkpoint_expired - runtime.session_history_unavailable - runtime.session_event_index_preparing - runtime.harness_unavailable - runtime.harness_failed - runtime.runner_unavailable - runtime.provider_host_unavailable - runtime.lease_lost - runtime.start_timeout - runtime.allocation_failed - runtime.allocation_not_ready - runtime.provisioning_suspended - runtime.computer_unavailable - runtime.turn_deadline_exceeded - runtime.observation_gap - runtime.observation_conflict - runtime.attestation_invalid - runtime.harness_incompatible - runtime.target_mismatch - runtime.transcript_index_unavailable - runtime.internal Objects_249: type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ name: type: string maxLength: 255 condition: anyOf: - type: object properties: kind: type: string enum: - predicates predicates: type: array items: $ref: '#/components/schemas/Union_380' minItems: 1 maxItems: 10 check: false input: anyOf: - type: object properties: kind: type: string enum: - trigger_payload required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - previous_step_output required: - kind additionalProperties: false required: - kind - predicates additionalProperties: false - type: object properties: kind: type: string enum: - check check: $ref: '#/components/schemas/Union_382' predicates: false input: anyOf: - type: object properties: kind: type: string enum: - trigger_payload required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - previous_step_output required: - kind additionalProperties: false required: - kind - check additionalProperties: false group: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ action: anyOf: - $ref: '#/components/schemas/AutomationStepBudgetRequiresNewSession' - $ref: '#/components/schemas/Objects_257' - $ref: '#/components/schemas/Objects_258' - type: object properties: action: type: string enum: - mark_sessions_processed query_step: type: string minLength: 1 maxLength: 132 pattern: >- ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ required_effects: type: array items: type: string minLength: 1 maxLength: 132 pattern: >- ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ maxItems: 20 required: - action - query_step - required_effects additionalProperties: false - $ref: '#/components/schemas/Objects_259' - $ref: '#/components/schemas/AutomationModelCallPromptNamesItsInputs' - type: object properties: action: type: string enum: - propose_skill_update query_step: type: string minLength: 1 maxLength: 132 pattern: >- ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ parameters: $ref: '#/components/schemas/AutomationSkillProposalParameters' input_bindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 2 join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false required: - action - query_step - model_routing_profile_key additionalProperties: false - $ref: '#/components/schemas/Objects_265' - $ref: '#/components/schemas/Objects_266' - $ref: '#/components/schemas/Objects_267' - $ref: '#/components/schemas/Objects_268' - $ref: '#/components/schemas/Objects_269' - $ref: '#/components/schemas/Objects_270' - $ref: '#/components/schemas/AutomationMemoryWriteInput' - $ref: '#/components/schemas/Objects_271' - $ref: '#/components/schemas/Objects_272' - $ref: '#/components/schemas/Objects_276' - $ref: '#/components/schemas/Objects_277' - $ref: '#/components/schemas/Objects_278' - $ref: '#/components/schemas/Objects_279' - type: object properties: action: type: string enum: - repeat max_attempts: type: integer minimum: 1 maximum: 20 input_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' input_bindings: $ref: '#/components/schemas/AutomationRepeatBindings' carry_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' initial_carry_bindings: $ref: '#/components/schemas/AutomationRepeatBindings' output_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' body: type: object properties: nodes: type: array items: anyOf: - type: object properties: id: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ name: type: string maxLength: 255 condition: anyOf: - type: object properties: kind: type: string enum: - predicates predicates: type: array items: $ref: '#/components/schemas/Union_380' minItems: 1 maxItems: 10 check: false input: anyOf: - type: object properties: kind: type: string enum: - trigger_payload required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - previous_step_output required: - kind additionalProperties: false required: - kind - predicates additionalProperties: false - type: object properties: kind: type: string enum: - check check: $ref: '#/components/schemas/Union_382' predicates: false input: anyOf: - type: object properties: kind: type: string enum: - trigger_payload required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - previous_step_output required: - kind additionalProperties: false required: - kind - check additionalProperties: false action: anyOf: - $ref: >- #/components/schemas/AutomationStepBudgetRequiresNewSession - $ref: '#/components/schemas/Objects_257' - $ref: '#/components/schemas/Objects_259' - $ref: '#/components/schemas/Objects_267' - $ref: '#/components/schemas/Objects_268' - $ref: '#/components/schemas/Objects_269' - $ref: '#/components/schemas/Objects_271' - $ref: '#/components/schemas/Objects_272' - $ref: '#/components/schemas/Objects_278' - $ref: '#/components/schemas/Objects_279' - $ref: '#/components/schemas/Objects_281' - $ref: '#/components/schemas/Objects_282' required: - id - action additionalProperties: false - $ref: '#/components/schemas/Objects_283' minItems: 2 maxItems: 29 edges: type: array items: $ref: '#/components/schemas/Union_412' maxItems: 320 required: - nodes - edges additionalProperties: false required: - action - max_attempts - input_schema - input_bindings - carry_schema - initial_carry_bindings - output_schema - body additionalProperties: false - $ref: '#/components/schemas/Objects_281' - $ref: '#/components/schemas/Objects_282' - type: object properties: action: type: string enum: - repeat_result max_attempts: type: integer minimum: 1 maximum: 20 output_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' carry_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' required: - action - max_attempts - output_schema - carry_schema additionalProperties: false required: - id - action additionalProperties: false Objects_283: type: object properties: kind: type: string enum: - decision id: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ condition: anyOf: - type: object properties: kind: type: string enum: - predicates predicates: type: array items: anyOf: - $ref: '#/components/schemas/Union_411' - type: object properties: kind: type: string enum: - any predicates: type: array items: $ref: '#/components/schemas/Union_411' minItems: 2 maxItems: 10 required: - kind - predicates additionalProperties: false - $ref: '#/components/schemas/Objects_284' minItems: 1 maxItems: 10 check: false input: anyOf: - $ref: '#/components/schemas/Objects_285' - $ref: '#/components/schemas/Objects_260' required: - kind - predicates - input additionalProperties: false - $ref: '#/components/schemas/AutomationDecisionCheckInput' required: - kind - id - condition additionalProperties: false Union_412: anyOf: - $ref: '#/components/schemas/Objects_288' - $ref: '#/components/schemas/Objects_289' - $ref: '#/components/schemas/Objects_290' - $ref: '#/components/schemas/Objects_291' - $ref: '#/components/schemas/Objects_292' - $ref: '#/components/schemas/Objects_293' - type: object properties: kind: type: string enum: - failure from: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ to: $ref: '#/components/schemas/Union_413' when: type: array items: $ref: '#/components/schemas/Union_301' minItems: 1 required: - kind - from - to - when additionalProperties: false AutomationRunLimitsNonEmpty_3: type: object properties: deadline_seconds: type: integer minimum: 60 maximum: 604800 max_concurrent_children: type: integer minimum: 1 maximum: 8 budget: $ref: '#/components/schemas/Objects_159' additionalProperties: false minProperties: 1 Objects_295: type: object properties: type: type: string enum: - json_pointer pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ required: - type - pointer additionalProperties: false Union_380: anyOf: - type: object properties: kind: type: string enum: - exists pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ value: false required: - kind - pointer additionalProperties: false - type: object properties: kind: type: string enum: - equals pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ value: $ref: '#/components/schemas/Union_253' required: - kind - pointer - value additionalProperties: false - type: object properties: kind: type: string enum: - contains pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ value: type: string minLength: 1 maxLength: 4096 required: - kind - pointer - value additionalProperties: false Objects_250: type: object properties: model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ tier: $ref: '#/components/schemas/Union_174' instructions: type: string minLength: 1 maxLength: 4096 failure: $ref: '#/components/schemas/Union_383' required: - model_routing_profile_key - instructions - failure additionalProperties: false TypedCheckQuestions_8: type: array items: anyOf: - $ref: '#/components/schemas/Objects_252' - type: object properties: key: $ref: '#/components/schemas/CheckQuestionKey' type: type: string enum: - choice instructions: type: string minLength: 1 maxLength: 4096 options: $ref: '#/components/schemas/CheckChoiceOptions_6' required: - key - type - instructions - options additionalProperties: false - type: object properties: key: $ref: '#/components/schemas/CheckQuestionKey' type: type: string enum: - score instructions: type: string minLength: 1 maxLength: 4096 levels: $ref: '#/components/schemas/CheckScoreLevels_6' required: - key - type - instructions - levels additionalProperties: false minItems: 1 maxItems: 8 CheckBooleanRuleThresholds_1: type: object properties: type: type: string enum: - boolean question_key: $ref: '#/components/schemas/CheckQuestionKey' expected: type: boolean false_max: type: number minimum: 0 maximum: 1 true_min: type: number minimum: 0 maximum: 1 required: - type - question_key - expected - false_max - true_min additionalProperties: false Objects_296: type: object properties: type: type: string enum: - choice_matches question_key: $ref: '#/components/schemas/CheckQuestionKey' option_keys: $ref: '#/components/schemas/CheckChoiceMatchesOptions_6' min_probability: type: number minimum: 0 maximum: 1 min_margin: type: number minimum: 0 maximum: 1 required: - type - question_key - option_keys - min_probability - min_margin additionalProperties: false CheckScoreTailRuleThresholds_1: type: object properties: type: type: string enum: - score_tail question_key: $ref: '#/components/schemas/CheckQuestionKey' at_or_above_level: type: integer minimum: 0 maximum: 9007199254740991 false_max: type: number minimum: 0 maximum: 1 true_min: type: number minimum: 0 maximum: 1 required: - type - question_key - at_or_above_level - false_max - true_min additionalProperties: false Objects_219: type: object properties: kind: type: string enum: - checkfu required: - kind additionalProperties: false Union_255: type: string enum: - sha256 - sha1 Union_256: type: string enum: - hex - base64 Objects_220: type: object properties: kind: type: string enum: - header_token header: type: string minLength: 1 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*$ description: A lowercase HTTP header name, such as x-hub-signature-256. required: - kind - header additionalProperties: false Objects_221: type: object properties: kind: type: string enum: - url_token required: - kind additionalProperties: false Union_311: type: string enum: - ambient - direct Objects_121: type: object properties: key: type: string minLength: 1 maxLength: 64 pattern: ^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$ description: $ref: '#/components/schemas/FlowReviewCriterionDescription' severity: type: string enum: - low - medium - high required: - key - description - severity additionalProperties: false TypedCheckQuestions_7: type: array items: anyOf: - $ref: '#/components/schemas/Objects_252' - type: object properties: key: $ref: '#/components/schemas/CheckQuestionKey' type: type: string enum: - choice instructions: type: string minLength: 1 maxLength: 4096 options: $ref: '#/components/schemas/CheckChoiceOptions_5' required: - key - type - instructions - options additionalProperties: false - type: object properties: key: $ref: '#/components/schemas/CheckQuestionKey' type: type: string enum: - score instructions: type: string minLength: 1 maxLength: 4096 levels: $ref: '#/components/schemas/CheckScoreLevels_5' required: - key - type - instructions - levels additionalProperties: false minItems: 1 maxItems: 8 CheckBooleanRuleThresholds: type: object properties: type: type: string enum: - boolean question_key: $ref: '#/components/schemas/CheckQuestionKey' expected: type: boolean false_max: type: number minimum: 0 maximum: 1 true_min: type: number minimum: 0 maximum: 1 required: - type - question_key - expected - false_max - true_min additionalProperties: false Objects_254: type: object properties: type: type: string enum: - choice_matches question_key: $ref: '#/components/schemas/CheckQuestionKey' option_keys: $ref: '#/components/schemas/CheckChoiceMatchesOptions_5' min_probability: type: number minimum: 0 maximum: 1 min_margin: type: number minimum: 0 maximum: 1 required: - type - question_key - option_keys - min_probability - min_margin additionalProperties: false CheckScoreTailRuleThresholds: type: object properties: type: type: string enum: - score_tail question_key: $ref: '#/components/schemas/CheckQuestionKey' at_or_above_level: type: integer minimum: 0 maximum: 9007199254740991 false_max: type: number minimum: 0 maximum: 1 true_min: type: number minimum: 0 maximum: 1 required: - type - question_key - at_or_above_level - false_max - true_min additionalProperties: false AutomationBlockDocument: type: object properties: name: type: string maxLength: 200 runs_as: type: string maxLength: 128 environment_id: $ref: '#/components/schemas/EnvironmentId' blocks: type: array items: $ref: '#/components/schemas/AutomationBlock_1' maxItems: 64 wires: type: array items: $ref: '#/components/schemas/AutomationBlockWire' maxItems: 256 run_limits: type: object properties: deadline_seconds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 max_concurrent_children: type: integer minimum: -9007199254740991 maximum: 9007199254740991 budget: type: object properties: limit: type: number metric: type: string enum: - model_spend - model_tokens required: - limit additionalProperties: false additionalProperties: false required: - name - runs_as - blocks - wires additionalProperties: false description: >- An automation document: a trigger block and the blocks it starts, connected by wires. AutomationBlockProblem: type: object properties: code: type: string block: type: string message: type: string required: - code - message additionalProperties: false AutomationBlockWarning: type: object properties: code: type: string block: type: string message: type: string required: - code - block - message additionalProperties: false AgentId: type: string pattern: ^agent_[0-9a-f]{32}$ ManagedAgentsContentBlock: anyOf: - type: object properties: type: type: string enum: - text text: type: string required: - type - text additionalProperties: false - type: object properties: type: type: string enum: - image source: anyOf: - type: object properties: type: type: string enum: - base64 data: type: string media_type: type: string required: - type - data - media_type additionalProperties: false - type: object properties: type: type: string enum: - url url: type: string required: - type - url additionalProperties: false - type: object properties: type: type: string enum: - file file_id: $ref: '#/components/schemas/FileId' required: - type - file_id additionalProperties: false required: - type - source additionalProperties: false - type: object properties: type: type: string enum: - document source: anyOf: - type: object properties: type: type: string enum: - base64 data: type: string media_type: type: string required: - type - data - media_type additionalProperties: false - type: object properties: type: type: string enum: - text data: type: string media_type: type: string enum: - text/plain required: - type - data - media_type additionalProperties: false - type: object properties: type: type: string enum: - url url: type: string required: - type - url additionalProperties: false - type: object properties: type: type: string enum: - file file_id: $ref: '#/components/schemas/FileId' required: - type - file_id additionalProperties: false context: anyOf: - type: string - type: 'null' title: anyOf: - type: string - type: 'null' required: - type - source additionalProperties: false - type: object properties: type: type: string enum: - redacted required: - type additionalProperties: false Objects_234: type: object properties: type: type: string enum: - text text: type: string minLength: 1 required: - type - text additionalProperties: false GitReference: type: string minLength: 1 maxLength: 1024 pattern: ^\S+$ Union_158: anyOf: - type: object properties: kind: type: string enum: - canonical required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - session session: $ref: '#/components/schemas/SessionId' required: - kind - session additionalProperties: false - type: object properties: kind: type: string enum: - proposal proposal: $ref: '#/components/schemas/MemoryProposalId' required: - kind - proposal additionalProperties: false - type: object properties: kind: type: string enum: - curation run: $ref: '#/components/schemas/CurationRunId' required: - kind - run additionalProperties: false Union_152: anyOf: - $ref: '#/components/schemas/MemoryVersionId' - $ref: '#/components/schemas/MemorySnapshotId' Union_382: anyOf: - $ref: '#/components/schemas/Objects_250' - type: object properties: evaluation: $ref: '#/components/schemas/Objects_251' rule: $ref: '#/components/schemas/Union_386' failure: $ref: '#/components/schemas/Union_383' required: - evaluation - rule - failure additionalProperties: false AutomationStepBudgetRequiresNewSession: anyOf: - type: object properties: action: type: string enum: - run_agent budget: $ref: '#/components/schemas/SessionBudgetRequest' session_target: $ref: '#/components/schemas/AutomationAgentSessionTarget' agent: $ref: '#/components/schemas/ManagedAgentsAgentParams_4' agent_deployment_revision_selection: false retry: $ref: '#/components/schemas/AutomationStepRetry' prompt: type: string minLength: 1 maxLength: 16384 input: false for_each: false required: - action - agent - prompt additionalProperties: false - type: object properties: action: type: string enum: - run_agent budget: $ref: '#/components/schemas/SessionBudgetRequest' session_target: $ref: '#/components/schemas/AutomationAgentSessionTarget' agent: $ref: '#/components/schemas/ManagedAgentsAgentParams_4' agent_deployment_revision_selection: false retry: $ref: '#/components/schemas/AutomationStepRetry' prompt: type: string minLength: 1 maxLength: 16384 input: $ref: '#/components/schemas/Objects_255' for_each: $ref: '#/components/schemas/AutomationStepForEach' prompt_rendering: type: string enum: - in_place required: - action - agent - prompt - input additionalProperties: false - type: object properties: action: type: string enum: - run_agent budget: $ref: '#/components/schemas/SessionBudgetRequest' session_target: $ref: '#/components/schemas/AutomationAgentSessionTarget' agent: $ref: '#/components/schemas/ManagedAgentsAgentParams_4' agent_deployment_revision_selection: false retry: $ref: '#/components/schemas/AutomationStepRetry' input: $ref: '#/components/schemas/Objects_256' prompt: false for_each: false required: - action - agent - input additionalProperties: false - $ref: '#/components/schemas/AutomationStepPromptNamesItsInputs' allOf: - anyOf: - properties: budget: false - properties: session_target: properties: mode: const: start_new description: an authored step Budget requires a newly created child Session Objects_257: type: object properties: action: type: string enum: - parse_json input_bindings: $ref: '#/components/schemas/AutomationJsonInputBindings' output_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' policy_version: type: number enum: - 1 required: - action - input_bindings - output_schema - policy_version additionalProperties: false Objects_258: type: object properties: action: type: string enum: - query_sessions agent: $ref: '#/components/schemas/AgentId' limit: type: integer minimum: 1 maximum: 100 scan_limit: type: integer minimum: 1 maximum: 1000 max_event_positions: type: integer minimum: 1 maximum: 1000 required: - action - agent - limit - scan_limit additionalProperties: false Objects_259: type: object properties: action: type: string enum: - check check: $ref: '#/components/schemas/Union_382' input: $ref: '#/components/schemas/Objects_260' required: - action - check additionalProperties: false AutomationModelCallPromptNamesItsInputs: type: object properties: action: type: string enum: - call_model model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ tier: $ref: '#/components/schemas/Union_174' prompt: type: string minLength: 1 maxLength: 16384 input_bindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 32 minProperties: 1 join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false response_format: $ref: '#/components/schemas/AutomationModelResponseFormat' max_output_tokens: type: integer minimum: 1 maximum: 16384 required: - action - model_routing_profile_key - prompt - response_format additionalProperties: false AutomationSkillProposalParameters: type: object properties: instructions: type: string minLength: 1 maxLength: 4096 skill_name: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ additionalProperties: false AutomationAgentOutputBinding: type: object properties: source: $ref: '#/components/schemas/Union_391' pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ required: - source - pointer additionalProperties: false Objects_265: type: object properties: action: type: string enum: - observe_skill_proposal proposal_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ required: - action - proposal_step additionalProperties: false Objects_266: type: object properties: action: type: string enum: - read_skill skill: $ref: '#/components/schemas/SkillId' version: anyOf: - type: string pattern: ^skillver_[0-9a-f]{64}$ - type: string enum: - latest - type: integer minimum: 1 maximum: 9007199254740991 required: - action - skill additionalProperties: false Objects_267: type: object properties: action: type: string enum: - read_file file_id: $ref: '#/components/schemas/FileId' expected_sha256: type: string pattern: ^sha256:[0-9a-f]{64}$ expected_size_bytes: type: integer minimum: 0 maximum: 9007199254740991 input_bindings: false required: - action - file_id - expected_sha256 - expected_size_bytes additionalProperties: false Objects_268: type: object properties: action: type: string enum: - read_file input_bindings: $ref: '#/components/schemas/AutomationFileSelectionBindings' file_id: false expected_sha256: false expected_size_bytes: false required: - action - input_bindings additionalProperties: false Objects_269: type: object properties: action: type: string enum: - write_file filename: type: string minLength: 1 maxLength: 500 pattern: ^(?!\.{1,2}$)[^/\\\p{Cc}]+$ mime_type: $ref: '#/components/schemas/Union_285' input_bindings: $ref: '#/components/schemas/AutomationJsonInputBindings' required: - action - filename - mime_type - input_bindings additionalProperties: false Objects_270: type: object properties: action: type: string enum: - read_memory memory_store: $ref: '#/components/schemas/MemoryStoreId' path: $ref: '#/components/schemas/MemoryPath' required: - action - memory_store - path additionalProperties: false AutomationMemoryWriteInput: type: object properties: action: type: string enum: - write_memory memory_store: $ref: '#/components/schemas/MemoryStoreId' operation: type: string enum: - delete publication: type: string enum: - proposal parameters: $ref: '#/components/schemas/AutomationMemoryWriteParameters_3' input_bindings: $ref: '#/components/schemas/AutomationMemoryWriteBindings' join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false required: - action - memory_store additionalProperties: false Objects_271: type: object properties: action: type: string enum: - call_connection connection: $ref: '#/components/schemas/ConnectionId' tool: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ arguments: $ref: '#/components/schemas/AutomationStepArguments' argument_bindings: $ref: '#/components/schemas/AutomationStepArgumentBindings' join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false acted_as: false retry: $ref: '#/components/schemas/AutomationConnectionStepRetry' output_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' file_bindings: $ref: '#/components/schemas/AutomationConnectionFileBindings' required: - action - connection - tool additionalProperties: false Objects_272: type: object properties: action: type: string enum: - request_approval context: anyOf: - $ref: '#/components/schemas/Objects_273' - $ref: '#/components/schemas/Objects_274' - type: object properties: type: type: string enum: - business_review version: type: number enum: - 1 input_bindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 8 minProperties: 1 join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false choices: $ref: '#/components/schemas/AutomationReviewChoiceKeysUnique_3' feedback_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' required: - type - version - input_bindings - choices additionalProperties: false - $ref: '#/components/schemas/Objects_275' approver: $ref: '#/components/schemas/PrincipalId' message: type: string minLength: 1 maxLength: 16384 timeout_seconds: type: integer maximum: 604800 exclusiveMinimum: 0 required: - action - message additionalProperties: false Objects_276: type: object properties: action: type: string enum: - respond_memory_proposal proposal_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ approval_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ required: - action - proposal_step - approval_step additionalProperties: false Objects_277: type: object properties: action: type: string enum: - respond_skill_proposal proposal_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ approval_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ skill_source: $ref: '#/components/schemas/SkillSourceId' verification: $ref: '#/components/schemas/Objects_137' required: - action - proposal_step - approval_step - verification additionalProperties: false Objects_278: type: object properties: action: type: string enum: - wait seconds: type: integer maximum: 604800 exclusiveMinimum: 0 required: - action - seconds additionalProperties: false Objects_279: type: object properties: action: type: string enum: - await_event match: $ref: '#/components/schemas/AutomationEventMatch' select: $ref: '#/components/schemas/AutomationEventSelect' timeout_seconds: type: integer maximum: 604800 exclusiveMinimum: 0 join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false required: - action - match - select - timeout_seconds additionalProperties: false AutomationJsonOutputSchema: type: object additionalProperties: description: >- A value in the JSON data model: null, boolean, finite number, string, array, or object. allOf: - x-checkfu-json-budget: maximumBytes: 8192 maximumDepth: 64 maximumNodes: 5000 maximumInspectionWork: 10000 x-checkfu-unicode-scalar-values: true allOf: - x-checkfu-json-budget: maximumBytes: 8192 maximumDepth: 64 maximumNodes: 5000 maximumInspectionWork: 10000 x-checkfu-unicode-scalar-values: true maxProperties: 5000 description: >- A standard Draft-07 JSON Schema declaration of at most 8 KiB; pattern, patternProperties, format, uniqueItems, multipleOf, dependencies, unsupported dialects and recursive references are refused. Local references use structural schema locations with ASCII keys. Execution is subject to a bounded validation-work budget. AutomationRepeatBindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/Union_404' maxProperties: 32 Objects_281: type: object properties: action: type: string enum: - repeat_open repeat: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ iteration: type: integer minimum: 1 maximum: 20 max_attempts: type: integer minimum: 1 maximum: 20 input_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' carry_schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' input_bindings: $ref: '#/components/schemas/AutomationRepeatBindings' initial_carry_bindings: $ref: '#/components/schemas/AutomationRepeatBindings' required: - action additionalProperties: false Objects_282: type: object properties: action: type: string enum: - repeat_return return: $ref: '#/components/schemas/Union_410' reason: type: string pattern: ^[a-z][a-z0-9_]{0,63}$ bindings: $ref: '#/components/schemas/AutomationRepeatBindings' repeat: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ iteration: type: integer minimum: 1 maximum: 20 required: - action - return - bindings additionalProperties: false Union_411: anyOf: - $ref: '#/components/schemas/Union_380' - type: object properties: kind: type: string enum: - equals_field pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ other_pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ value: false required: - kind - pointer - other_pointer additionalProperties: false - type: object properties: kind: type: string enum: - compare pointer: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ op: type: string enum: - lt - lte - gt - gte value: type: number minimum: -9007199254740991 maximum: 9007199254740991 required: - kind - pointer - op - value additionalProperties: false Objects_284: type: object properties: kind: type: string enum: - not predicate: $ref: '#/components/schemas/Union_411' required: - kind - predicate additionalProperties: false Objects_285: type: object properties: kind: type: string enum: - previous_step_output required: - kind additionalProperties: false Objects_260: type: object properties: kind: type: string enum: - mapped bindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 32 minProperties: 1 join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false required: - kind - bindings additionalProperties: false AutomationDecisionCheckInput: type: object properties: kind: type: string enum: - check check: anyOf: - $ref: '#/components/schemas/Objects_286' - type: object properties: evaluation: $ref: '#/components/schemas/Objects_251' rule: $ref: '#/components/schemas/Union_386' failure: type: string enum: - fail_closed required: - evaluation - rule - failure additionalProperties: false predicates: false input: anyOf: - $ref: '#/components/schemas/Objects_285' - $ref: '#/components/schemas/Objects_287' - $ref: '#/components/schemas/Objects_260' required: - kind - check - input additionalProperties: false Objects_288: type: object properties: kind: type: string enum: - then from: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ to: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ required: - kind - from - to additionalProperties: false Objects_289: type: object properties: kind: type: string enum: - output from: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ to: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ required: - kind - from - to additionalProperties: false Objects_290: type: object properties: kind: type: string enum: - continue from: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ to: anyOf: - type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ - type: 'null' result: type: string enum: - not_passed required: - kind - from - to additionalProperties: false Objects_291: type: object properties: kind: type: string enum: - otherwise from: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ to: anyOf: - type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ - type: 'null' result: type: string enum: - not_passed required: - kind - from - to additionalProperties: false Objects_292: type: object properties: kind: type: string enum: - uncertain from: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ to: anyOf: - type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ - type: 'null' required: - kind - from - to additionalProperties: false Objects_293: type: object properties: kind: type: string enum: - error from: type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ to: anyOf: - type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ - type: 'null' required: - kind - from - to additionalProperties: false Union_413: anyOf: - type: string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9_]+$ - type: 'null' Union_301: type: string enum: - refused - failed - timeout - denied - unconfirmed Objects_159: type: object properties: limit: $ref: '#/components/schemas/AutomationRunBudgetSafeLimit' metric: type: string enum: - model_spend - model_tokens required: - limit additionalProperties: false Union_253: anyOf: - type: string maxLength: 4096 - type: boolean - type: number minimum: -9007199254740991 maximum: 9007199254740991 Objects_252: type: object properties: key: $ref: '#/components/schemas/CheckQuestionKey' type: type: string enum: - boolean instructions: type: string minLength: 1 maxLength: 4096 true_description: $ref: '#/components/schemas/CheckDescription_1' false_description: $ref: '#/components/schemas/CheckDescription_1' required: - key - type - instructions additionalProperties: false CheckQuestionKey: type: string minLength: 1 maxLength: 64 CheckChoiceOptions_6: type: array items: $ref: '#/components/schemas/Objects_253' minItems: 2 maxItems: 32 CheckScoreLevels_6: type: array items: $ref: '#/components/schemas/CheckDescription_1' minItems: 2 maxItems: 10 CheckChoiceMatchesOptions_6: type: array items: $ref: '#/components/schemas/CheckQuestionKey' minItems: 1 FlowReviewCriterionDescription: type: string minLength: 1 maxLength: 1024 CheckChoiceOptions_5: type: array items: $ref: '#/components/schemas/Objects_253' minItems: 2 maxItems: 32 CheckScoreLevels_5: type: array items: $ref: '#/components/schemas/CheckDescription_1' minItems: 2 maxItems: 10 CheckChoiceMatchesOptions_5: type: array items: $ref: '#/components/schemas/CheckQuestionKey' minItems: 1 AutomationBlock_1: anyOf: - type: object properties: id: type: string maxLength: 128 name: type: string maxLength: 200 type: type: string enum: - trigger trigger: $ref: '#/components/schemas/AutomationBlockTrigger_1' required: - id - type - trigger additionalProperties: false - type: object properties: id: type: string maxLength: 128 name: type: string maxLength: 200 type: type: string enum: - agent agent: type: string maxLength: 128 prompt: type: string maxLength: 65536 output_schema: $ref: '#/components/schemas/AutomationBlockJsonObject' budget: type: object properties: limit: type: number metric: type: string enum: - model_tokens - model_spend - session_runtime_ms - web_search_requests - total_spend required: - limit additionalProperties: false for_each: type: object properties: items: type: string maxLength: 1024 max_items: type: integer minimum: -9007199254740991 maximum: 9007199254740991 concurrency: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - items - max_items additionalProperties: false required: - id - type - agent - prompt additionalProperties: false - type: object properties: id: type: string maxLength: 128 name: type: string maxLength: 200 type: type: string enum: - model route: $ref: '#/components/schemas/Objects_223' prompt: type: string maxLength: 65536 format: anyOf: - $ref: '#/components/schemas/Objects_224' - type: object properties: type: type: string enum: - pick_one options: type: array items: type: string maxLength: 128 maxItems: 20 required: - type - options additionalProperties: false - $ref: '#/components/schemas/Objects_225' - type: object properties: type: type: string enum: - extract schema: $ref: '#/components/schemas/AutomationBlockJsonObject' required: - type - schema additionalProperties: false - $ref: '#/components/schemas/Objects_226' required: - id - type - route - prompt - format additionalProperties: false - type: object properties: id: type: string maxLength: 128 name: type: string maxLength: 200 type: type: string enum: - if cases: type: array items: type: object properties: id: type: string maxLength: 128 when: anyOf: - type: object properties: all: $ref: '#/components/schemas/Arrays_40' any: false required: - all additionalProperties: false - type: object properties: any: $ref: '#/components/schemas/Arrays_40' all: false required: - any additionalProperties: false required: - id - when additionalProperties: false maxItems: 20 required: - id - type - cases additionalProperties: false - type: object properties: id: type: string maxLength: 128 name: type: string maxLength: 200 type: type: string enum: - resource resource: $ref: '#/components/schemas/AutomationBlockResource_1' ask_first: type: object properties: approver: type: string maxLength: 128 required: - approver additionalProperties: false required: - id - type - resource additionalProperties: false AutomationBlockWire: type: object properties: from: type: string maxLength: 128 to: type: string maxLength: 128 port: type: string maxLength: 128 max_attempts: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - from - to additionalProperties: false MemoryProposalId: type: string pattern: ^mprop_[0-9a-f]{32}$ CurationRunId: type: string pattern: ^mcur_[0-9a-f]{32}$ MemoryVersionId: type: string pattern: ^memver_[0-9a-f]{32}$ MemorySnapshotId: type: string pattern: ^memsnap_[0-9a-f]{32}$ AutomationStepRetry: type: object properties: max_attempts: type: integer minimum: 2 maximum: 5 wait_seconds: type: integer minimum: 0 maximum: 3600 required: - max_attempts - wait_seconds additionalProperties: false Objects_255: type: object properties: kind: type: string enum: - trigger_payload required: - kind additionalProperties: false AutomationStepForEach: type: object properties: items: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ max_items: type: integer minimum: 1 maximum: 50 concurrency: type: integer minimum: 1 maximum: 8 required: - items - max_items additionalProperties: false Objects_256: type: object properties: kind: type: string enum: - previous_step_output required: - kind additionalProperties: false AutomationStepPromptNamesItsInputs: type: object properties: action: type: string enum: - run_agent budget: $ref: '#/components/schemas/SessionBudgetRequest' session_target: $ref: '#/components/schemas/AutomationAgentSessionTarget' agent: $ref: '#/components/schemas/ManagedAgentsAgentParams_4' agent_deployment_revision_selection: false retry: $ref: '#/components/schemas/AutomationStepRetry' prompt: type: string minLength: 1 maxLength: 16384 input: type: object properties: kind: type: string enum: - mapped bindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 32 minProperties: 1 required: - kind - bindings additionalProperties: false join: type: object properties: kind: type: string enum: - all_completed required: - kind additionalProperties: false for_each: false prompt_rendering: type: string enum: - in_place required: - action - agent - prompt - input additionalProperties: false AutomationJsonInputBindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 32 AutomationModelResponseFormat: type: object properties: preset: $ref: '#/components/schemas/AutomationModelFormatPreset' schema: $ref: '#/components/schemas/AutomationJsonOutputSchema' required: - preset - schema additionalProperties: false Union_391: anyOf: - type: object properties: kind: type: string enum: - trigger_payload required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - agent_output step_id: type: string minLength: 1 maxLength: 132 pattern: >- ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ required: - kind - step_id additionalProperties: false - type: object properties: kind: type: string enum: - data_output step_id: type: string minLength: 1 maxLength: 132 pattern: >- ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ required: - kind - step_id additionalProperties: false SkillId: type: string pattern: ^skl_[0-9a-f]{32}$ AutomationFileSelectionBindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 32 Union_285: type: string enum: - application/json - text/plain - text/markdown MemoryPath: type: string maxLength: 1024 AutomationMemoryWriteParameters_3: type: object properties: path: $ref: '#/components/schemas/MemoryPath' content: $ref: '#/components/schemas/MemoryDocumentContentUtf8Bytes' media_type: type: string minLength: 1 maxLength: 255 expected_sha256: $ref: '#/components/schemas/Union_289' provenance: $ref: '#/components/schemas/NullableAutomationMemoryWriteProvenance_3' additionalProperties: false AutomationMemoryWriteBindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 5 ConnectionId: type: string pattern: ^conn_[0-9a-f]{32}$ AutomationStepArguments: type: object additionalProperties: description: >- A value in the JSON data model: null, boolean, finite number, string, array, or object. allOf: - x-checkfu-json-budget: maximumBytes: 8192 maximumDepth: 64 maximumNodes: 8192 maximumInspectionWork: 8192 x-checkfu-unicode-scalar-values: true allOf: - x-checkfu-json-budget: maximumBytes: 8192 maximumDepth: 64 maximumNodes: 8192 maximumInspectionWork: 8192 x-checkfu-unicode-scalar-values: true maxProperties: 8192 description: JSON tool arguments of at most 8192 bytes AutomationStepArgumentBindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: $ref: '#/components/schemas/AutomationAgentOutputBinding' maxProperties: 32 AutomationConnectionStepRetry: type: object properties: max_attempts: type: integer minimum: 2 maximum: 5 wait_seconds: type: integer minimum: 0 maximum: 3600 repeat_safety: $ref: '#/components/schemas/AutomationConnectionRetrySafety' required: - max_attempts - wait_seconds - repeat_safety additionalProperties: false AutomationConnectionFileBindings: type: object propertyNames: type: string minLength: 1 maxLength: 128 additionalProperties: type: object properties: input_bindings: $ref: '#/components/schemas/AutomationFileSelectionBindings' mime_type: type: string minLength: 1 maxLength: 255 pattern: ^[^\p{Cc}]+$ required: - input_bindings - mime_type additionalProperties: false minProperties: 1 maxProperties: 1 Objects_273: type: object properties: type: type: string enum: - memory_proposal proposal_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ required: - type - proposal_step additionalProperties: false Objects_274: type: object properties: type: type: string enum: - skill_proposal proposal_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ skill_source: $ref: '#/components/schemas/SkillSourceId' required: - type - proposal_step additionalProperties: false AutomationReviewChoiceKeysUnique_3: type: array items: $ref: '#/components/schemas/Objects_136' minItems: 2 maxItems: 4 Objects_275: type: object properties: type: type: string enum: - connection_call call_step: type: string minLength: 1 maxLength: 132 pattern: ^[A-Za-z0-9_]{1,64}(?:\.(?:[1-9]|1[0-9]|20)\.[A-Za-z0-9_]{1,64})?$ when: type: string enum: - required_by_policy required: - type - call_step additionalProperties: false SkillSourceId: type: string pattern: ^sksrc_[0-9a-f]{32}$ Objects_137: type: object properties: principal: $ref: '#/components/schemas/PrincipalId' environment_id: $ref: '#/components/schemas/EnvironmentId' evaluator_model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ required: - principal - environment_id - evaluator_model_routing_profile_key additionalProperties: false AutomationEventMatch: type: object additionalProperties: $ref: '#/components/schemas/Union_404' minProperties: 1 maxProperties: 8 propertyNames: maxLength: 512 pattern: ^(?:/(?:[^~/]|~[01])*)+$ AutomationEventSelect: type: object additionalProperties: type: string maxLength: 512 pattern: ^(?:\/(?:[^~/]|~[01])*)*$ maxProperties: 32 propertyNames: pattern: ^[A-Za-z0-9_]{1,64}$ Union_404: anyOf: - $ref: '#/components/schemas/AutomationAgentOutputBinding' - type: object properties: source: $ref: '#/components/schemas/Objects_280' value: $ref: '#/components/schemas/AutomationRepeatValue_5' required: - source - value additionalProperties: false Union_410: type: string enum: - complete - repeat - stopped Objects_286: type: object properties: model_routing_profile_key: type: string pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ tier: $ref: '#/components/schemas/Union_174' instructions: type: string minLength: 1 maxLength: 4096 failure: type: string enum: - fail_closed required: - model_routing_profile_key - instructions - failure additionalProperties: false Objects_287: type: object properties: kind: type: string enum: - trigger_payload required: - kind additionalProperties: false AutomationRunBudgetSafeLimit: type: integer maximum: 9007199254740991 exclusiveMinimum: 0 CheckDescription_1: type: string minLength: 1 Objects_253: type: object properties: key: $ref: '#/components/schemas/CheckQuestionKey' description: $ref: '#/components/schemas/CheckDescription_1' required: - key - description additionalProperties: false AutomationBlockTrigger_1: anyOf: - $ref: '#/components/schemas/Objects_217' - $ref: '#/components/schemas/Objects_218' - type: object properties: type: type: string enum: - webhook dedupe_pointer: type: string maxLength: 512 filter: $ref: '#/components/schemas/Arrays_40' verification: anyOf: - $ref: '#/components/schemas/Objects_219' - type: object properties: kind: type: string enum: - hmac header: type: string minLength: 1 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*$ description: >- A lowercase HTTP header name, such as x-hub-signature-256. algorithm: $ref: '#/components/schemas/Union_255' encoding: $ref: '#/components/schemas/Union_256' prefix: type: string minLength: 1 maxLength: 32 pattern: ^[\x21-\x7e]+$ separator: type: string enum: - ',' - ; - ' ' signature_field: type: string pattern: ^[A-Za-z0-9_]{1,16}$ secret_encoding: type: string enum: - text - base64 secret_prefix: type: string minLength: 1 maxLength: 32 pattern: ^[\x21-\x7e]+$ signed_payload: type: object properties: template: type: string minLength: 3 maxLength: 96 pattern: ^[\x20-\x7e]+$ timestamp: anyOf: - type: object properties: header: type: string minLength: 1 maxLength: 64 pattern: ^[a-z0-9][a-z0-9-]*$ description: >- A lowercase HTTP header name, such as x-hub-signature-256. required: - header additionalProperties: false - type: object properties: signature_field: type: string pattern: ^[A-Za-z0-9_]{1,16}$ required: - signature_field additionalProperties: false timestamp_unit: type: string enum: - seconds - milliseconds tolerance_seconds: type: integer minimum: 1 maximum: 3600 required: - template additionalProperties: false required: - kind - header - algorithm - encoding additionalProperties: false - $ref: '#/components/schemas/Objects_220' - $ref: '#/components/schemas/Objects_221' required: - type - dedupe_pointer additionalProperties: false - type: object properties: type: type: string enum: - app_event connection_id: type: string maxLength: 128 event: type: string maxLength: 256 arguments: $ref: '#/components/schemas/AutomationBlockJsonObject' resource: type: string maxLength: 512 required: - type - connection_id - event additionalProperties: false - $ref: '#/components/schemas/Objects_222' AutomationBlockJsonObject: type: object additionalProperties: description: >- A value in the JSON data model: null, boolean, finite number, string, array, or object. allOf: - x-checkfu-json-budget: maximumBytes: 65536 maximumDepth: 64 maximumNodes: 5000 maximumInspectionWork: 20000 x-checkfu-unicode-scalar-values: true allOf: - x-checkfu-json-budget: maximumBytes: 65536 maximumDepth: 64 maximumNodes: 5000 maximumInspectionWork: 20000 x-checkfu-unicode-scalar-values: true maxProperties: 5000 description: A JSON object, such as tool arguments or a JSON Schema. Objects_223: type: object properties: profile: type: string maxLength: 128 tier: type: string enum: - default - planning - tool_loop required: - profile additionalProperties: false Objects_224: type: object properties: type: type: string enum: - yes_no required: - type additionalProperties: false Objects_225: type: object properties: type: type: string enum: - score levels: type: integer minimum: -9007199254740991 maximum: 9007199254740991 pass_at: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - type - levels additionalProperties: false Objects_226: type: object properties: type: type: string enum: - text required: - type additionalProperties: false Arrays_40: type: array items: $ref: '#/components/schemas/AutomationBlockComparison_1' maxItems: 20 AutomationBlockResource_1: anyOf: - $ref: '#/components/schemas/Objects_227' - $ref: '#/components/schemas/Objects_228' - $ref: '#/components/schemas/Objects_229' - $ref: '#/components/schemas/Objects_230' - $ref: '#/components/schemas/Objects_231' - $ref: '#/components/schemas/Objects_232' - $ref: '#/components/schemas/Objects_233' - type: object properties: type: type: string enum: - connection connection_id: type: string maxLength: 128 tool: type: string maxLength: 256 arguments: $ref: '#/components/schemas/AutomationBlockJsonObject' required: - type - connection_id - tool additionalProperties: false AutomationModelFormatPreset: anyOf: - $ref: '#/components/schemas/Objects_261' - type: object properties: type: type: string enum: - pick_one options: type: array items: type: string pattern: ^[a-z0-9_]+$ maxLength: 40 minItems: 2 maxItems: 10 required: - type - options additionalProperties: false - $ref: '#/components/schemas/Objects_262' - $ref: '#/components/schemas/Objects_263' - $ref: '#/components/schemas/Objects_264' MemoryDocumentContentUtf8Bytes: type: string maxLength: 102400 description: Memory document text no larger than 102400 bytes when encoded as UTF-8 Union_289: anyOf: - type: string pattern: ^sha256:[0-9a-f]{64}$ - type: 'null' NullableAutomationMemoryWriteProvenance_3: anyOf: - $ref: '#/components/schemas/AutomationMemoryWriteProvenance_3' - type: 'null' AutomationConnectionRetrySafety: type: string enum: - tool_declared - idempotency_key Objects_136: type: object properties: key: type: string pattern: ^[a-z][a-z0-9_]{0,31}$ description: type: string minLength: 1 maxLength: 200 required: - key - description additionalProperties: false Objects_280: type: object properties: kind: type: string enum: - value required: - kind additionalProperties: false AutomationRepeatValue_5: x-checkfu-json-budget: maximumBytes: 8192 maximumDepth: 4096 maximumNodes: 4096 maximumInspectionWork: 8192 Objects_217: type: object properties: type: type: string enum: - schedule cron: type: string maxLength: 255 timezone: type: string maxLength: 64 required: - type - cron - timezone additionalProperties: false Objects_218: type: object properties: type: type: string enum: - once at: type: string maxLength: 64 required: - type - at additionalProperties: false Objects_222: type: object properties: type: type: string enum: - manual required: - type additionalProperties: false AutomationBlockComparison_1: type: object properties: field: type: string maxLength: 1024 op: $ref: '#/components/schemas/Union_340' value: anyOf: - $ref: '#/components/schemas/Union_341' - type: array items: $ref: '#/components/schemas/Union_341' maxItems: 50 required: - field - op additionalProperties: false Objects_227: type: object properties: type: type: string enum: - sessions agent: type: string maxLength: 128 limit: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - type - agent - limit additionalProperties: false Objects_228: type: object properties: type: type: string enum: - memory_store action: type: string enum: - read id: type: string maxLength: 128 path: type: string maxLength: 1024 required: - type - action - id - path additionalProperties: false Objects_229: type: object properties: type: type: string enum: - memory_store action: type: string enum: - write id: type: string maxLength: 128 path: type: string maxLength: 1024 content: type: string maxLength: 65536 mode: type: string enum: - create - update expected_sha256: type: string maxLength: 1024 required: - type - action - id - path - content - mode additionalProperties: false Objects_230: type: object properties: type: type: string enum: - memory_store action: type: string enum: - remove id: type: string maxLength: 128 path: type: string maxLength: 1024 expected_sha256: type: string maxLength: 1024 required: - type - action - id - path - expected_sha256 additionalProperties: false Objects_231: type: object properties: type: type: string enum: - skill action: type: string enum: - read id: type: string maxLength: 128 version: type: string maxLength: 128 required: - type - id additionalProperties: false Objects_232: type: object properties: type: type: string enum: - file action: type: string enum: - read file_id: type: string maxLength: 1024 required: - type - action - file_id additionalProperties: false Objects_233: type: object properties: type: type: string enum: - file action: type: string enum: - write filename: type: string maxLength: 256 mime_type: type: string enum: - application/json - text/plain - text/markdown content: type: string maxLength: 65536 required: - type - action - filename - mime_type - content additionalProperties: false Objects_261: type: object properties: type: type: string enum: - yes_no required: - type additionalProperties: false Objects_262: type: object properties: type: type: string enum: - score levels: type: integer minimum: 2 maximum: 10 pass_at: type: integer minimum: 1 maximum: 10 required: - type - levels additionalProperties: false Objects_263: type: object properties: type: type: string enum: - extract required: - type additionalProperties: false Objects_264: type: object properties: type: type: string enum: - text required: - type additionalProperties: false AutomationMemoryWriteProvenance_3: type: object properties: source_event_ids: type: array items: $ref: '#/components/schemas/EventId' maxItems: 65536 source_version_ids: type: array items: $ref: '#/components/schemas/Union_152' maxItems: 65536 source_refs: type: array items: type: string minLength: 1 maxLength: 1024 maxItems: 65536 curation_run: $ref: '#/components/schemas/CurationRunId' confidence: $ref: '#/components/schemas/Union_156' valid_from: type: string maxLength: 65536 supersedes: type: object properties: path: $ref: '#/components/schemas/MemoryPath' version: $ref: '#/components/schemas/Union_152' required: - path - version additionalProperties: false required: - source_event_ids - source_version_ids - source_refs - confidence - valid_from additionalProperties: false Union_340: type: string enum: - equals - not_equals - contains - exists - gt - gte - lt - lte - one_of Union_341: anyOf: - type: string - type: number - type: boolean EventId: type: string pattern: ^evt_[0-9a-f]{32}$ Union_156: type: string enum: - observed - inferred - uncertain securitySchemes: bearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.