decide-fyi Policy Patterns API

openapi: 3.2.0
info:
  title: Decide Decision Policy Patterns API
  summary: Decision protocol for state-changing software actions.
  description: Call Decide before products, agents, queues, billing systems, CRMs, or internal tools change state. The API returns a signed Decision Record v1 object with policy bundle attestation, evidence, action binding, replay, verification handles, portable Decision Packet v1 exports, simulation-only counterfactual analysis, cryptographic audit chains, Action Execution Receipts, Outcome Records, CRM Sync Records, predictive confidence, first-party policy pattern templates, policy effectiveness metrics, opt-in anonymized benchmarks, and explainable anomaly reports derived from reported outcomes.
  version: 1.13.0
  x-decision-protocol-version: decision_protocol_v1
  x-decision-record-version: decision_record_v1
  x-decision-packet-version: decision_packet_v1
servers:
- url: https://www.decide.fyi
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Policy Patterns
  description: First-party Decision API pattern templates for common state-changing integrations.
paths:
  /api/decision/policy-patterns:
    get:
      tags:
      - Policy Patterns
      operationId: listPolicyPatterns
      summary: Read the policy pattern registry
      description: Returns first-party Decision API pattern templates. Pass pattern_id for a single pattern or tag to filter the registry.
      security: []
      parameters:
      - name: pattern_id
        in: query
        required: false
        schema:
          type: string
        description: Optional pattern id or policy id to resolve a single policy pattern.
      - name: tag
        in: query
        required: false
        schema:
          type: string
        description: Optional tag filter for the registry view.
      responses:
        '200':
          description: Policy pattern registry or single policy pattern
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/DecisionPatternRegistry'
                - $ref: '#/components/schemas/DecisionPatternResponse'
        '404':
          description: Pattern not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    DecisionRequest:
      type: object
      anyOf:
      - required:
        - question
      - required:
        - prompt
        - context
      - required:
        - mode
        - rulebook
        - context
        properties:
          mode:
            const: rulebook
      properties:
        question:
          type: string
        mode:
          type: string
          enum:
          - single
          - multi
          - runtime
          - rulebook
        prompt:
          type: string
        stem:
          type: string
        options:
          type: array
          minItems: 2
          maxItems: 8
          items:
            type: string
        context:
          type:
          - object
          - string
          additionalProperties: true
        response_view:
          type: string
          enum:
          - minimal
          - standard
          - full
        rulebook:
          $ref: '#/components/schemas/RulebookV1'
        adapter:
          $ref: '#/components/schemas/TrustedAdapterInvocation'
      additionalProperties: false
    DecisionPatternRegistry:
      type: object
      required:
      - ok
      - decision_pattern_registry_version
      - patterns
      - registry_hash
      properties:
        ok:
          type: boolean
        decision_protocol_version:
          type: string
        decision_record_version:
          type: string
        decision_pattern_registry_version:
          type: string
          const: decision_pattern_registry_v1
        source:
          type: string
        status:
          type: string
        count:
          type: integer
        patterns:
          type: array
          items:
            $ref: '#/components/schemas/DecisionPattern'
        registry_hash:
          type: string
        endpoints:
          type: object
          additionalProperties:
            type: string
      additionalProperties: true
    TrustedAdapterInvocation:
      type: object
      required:
      - adapter_id
      - version
      - manifest_hash
      - input
      properties:
        adapter_id:
          type: string
          pattern: ^[a-z][a-z0-9_.:-]{1,119}$
        version:
          type: string
          pattern: ^[0-9]+\.[0-9]+\.[0-9]+$
        manifest_hash:
          type: string
          pattern: ^[a-f0-9]{64}$
        input:
          type: object
          additionalProperties: true
      additionalProperties: false
    DecisionPattern:
      type: object
      required:
      - decision_pattern_version
      - pattern_id
      - policy_id
      - pattern_hash
      properties:
        decision_pattern_version:
          type: string
          const: decision_pattern_v1
        pattern_id:
          type: string
        name:
          type: string
        version:
          type: string
        category:
          type: string
        status:
          type: string
        summary:
          type: string
        policy_id:
          type: string
        recommended_policy_version:
          type: string
        source:
          type: string
        tags:
          type: array
          items:
            type: string
        required_context_fields:
          type: array
          items:
            type: string
        recommended_context_fields:
          type: array
          items:
            type: string
        evidence_codes:
          type: array
          items:
            type: string
        decision_request_template:
          $ref: '#/components/schemas/DecisionRequest'
        outcome_template:
          type: object
          additionalProperties: true
        crm_sync_template:
          type: object
          additionalProperties: true
        sdk_examples:
          type: array
          items:
            type: string
        pattern_hash:
          type: string
      additionalProperties: true
    DecisionPatternResponse:
      type: object
      required:
      - ok
      - policy_pattern
      properties:
        ok:
          type: boolean
        policy_pattern:
          $ref: '#/components/schemas/DecisionPattern'
      additionalProperties: true
    RulebookRule:
      type: object
      required:
      - rule_id
      - condition
      - outcome
      properties:
        rule_id:
          type: string
          pattern: ^[a-z][a-z0-9_.:-]{1,119}$
        priority:
          type: integer
          minimum: -1000
          maximum: 1000
          default: 0
        condition:
          $ref: '#/components/schemas/RulebookCondition'
        outcome:
          $ref: '#/components/schemas/RulebookOutcome'
      additionalProperties: false
    RulebookInputSchema:
      type: object
      properties:
        required:
          type: array
          items:
            type: string
            pattern: ^[A-Za-z_][A-Za-z0-9_.-]{0,159}$
        properties:
          type: object
          additionalProperties:
            type: object
            required:
            - type
            properties:
              type:
                type: string
                enum:
                - string
                - number
                - integer
                - boolean
                - array
                - object
                - 'null'
            additionalProperties: false
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        c:
          type: string
        v:
          type: string
        request_id:
          type: string
        error:
          type: string
        message:
          type: string
      additionalProperties: true
    RulebookOutcome:
      type: object
      required:
      - decision
      - verdict
      - action
      - reason_code
      properties:
        decision:
          type: string
          enum:
          - 'yes'
          - 'no'
          - review
        verdict:
          type: string
          pattern: ^[A-Z][A-Z0-9_]{1,79}$
        action:
          type: string
          minLength: 1
          maxLength: 160
        reason_code:
          type: string
          pattern: ^[A-Z][A-Z0-9_]{1,79}$
      additionalProperties: false
    RulebookCondition:
      oneOf:
      - type: object
        required:
        - all
        properties:
          all:
            type: array
            minItems: 1
            maxItems: 32
            items:
              $ref: '#/components/schemas/RulebookCondition'
        additionalProperties: false
      - type: object
        required:
        - any
        properties:
          any:
            type: array
            minItems: 1
            maxItems: 32
            items:
              $ref: '#/components/schemas/RulebookCondition'
        additionalProperties: false
      - type: object
        required:
        - not
        properties:
          not:
            $ref: '#/components/schemas/RulebookCondition'
        additionalProperties: false
      - type: object
        required:
        - field
        - operator
        properties:
          field:
            type: string
            pattern: ^[A-Za-z_][A-Za-z0-9_.-]{0,159}$
          operator:
            type: string
            enum:
            - exists
            - not_exists
            - eq
            - neq
            - gt
            - gte
            - lt
            - lte
            - in
            - not_in
            - contains
            - not_contains
          value: {}
        additionalProperties: false
    RulebookV1:
      type: object
      required:
      - schema_version
      - rulebook_id
      - version
      - rules
      - default_outcome
      properties:
        schema_version:
          type: string
          const: rulebook_v1
        rulebook_id:
          type: string
          pattern: ^[a-z][a-z0-9_.:-]{1,119}$
        version:
          type: string
          minLength: 1
          maxLength: 80
        input_schema:
          $ref: '#/components/schemas/RulebookInputSchema'
        rules:
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/RulebookRule'
        default_outcome:
          $ref: '#/components/schemas/RulebookOutcome'
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key