> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit an iteration directive

> Resolves one AWAITING_DIRECTIVE pause: `CONTINUE` resumes with the withheld output delivered verbatim (free — resumes never bill); `FINISH_RUN` resumes with a wrap-up note so the agent concludes; `RESTART_RUN` abandons the parked attempt and starts a fresh one from the beginning against the agent's current (just-edited) config — bills like a normal run; `CANCEL` abandons the parked attempt and leaves the session open. 409 when the pause already received a directive. CONTINUE/FINISH_RUN require a parked tool output (an EVERY_STEP pause, not a RUN_COMPLETE one).



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json post /public-api/iteration-sessions/{session_id}/pauses/{pause_id}/directive
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/iteration-sessions/{session_id}/pauses/{pause_id}/directive:
    post:
      tags:
        - Iteration Sessions
      summary: Submit an iteration directive
      description: >-
        Resolves one AWAITING_DIRECTIVE pause: `CONTINUE` resumes with the
        withheld output delivered verbatim (free — resumes never bill);
        `FINISH_RUN` resumes with a wrap-up note so the agent concludes;
        `RESTART_RUN` abandons the parked attempt and starts a fresh one from
        the beginning against the agent's current (just-edited) config — bills
        like a normal run; `CANCEL` abandons the parked attempt and leaves the
        session open. 409 when the pause already received a directive.
        CONTINUE/FINISH_RUN require a parked tool output (an EVERY_STEP pause,
        not a RUN_COMPLETE one).
      operationId: public_api.iteration_sessions_submit_directive_post
      parameters:
        - in: path
          name: pause_id
          required: true
          schema:
            type: string
        - in: path
          name: session_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IterationDirectiveRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/PublicIterationPause'
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    IterationDirectiveRequest:
      properties:
        note:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Note
        type:
          $ref: '#/components/schemas/IterationDirectiveType'
      required:
        - type
      title: IterationDirectiveRequest
      type: object
    PublicIterationPause:
      properties:
        attempt:
          title: Attempt
          type: integer
        created_at:
          format: date-time
          title: Created At
          type: string
        directive:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Directive
        directive_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Directive By User Id
        execution_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Execution Id
        pause_id:
          title: Pause Id
          type: string
        pending_calls:
          items:
            $ref: '#/components/schemas/PublicIterationPendingCall'
          title: Pending Calls
          type: array
        seq:
          title: Seq
          type: integer
        session_id:
          title: Session Id
          type: string
        status:
          $ref: '#/components/schemas/IterationPauseStatus'
        trigger:
          $ref: '#/components/schemas/IterationPauseTrigger'
        withheld_outputs:
          additionalProperties:
            type: string
          title: Withheld Outputs
          type: object
      required:
        - pause_id
        - session_id
        - attempt
        - seq
        - execution_id
        - trigger
        - status
        - pending_calls
        - withheld_outputs
        - directive
        - directive_by_user_id
        - created_at
      title: PublicIterationPause
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    IterationDirectiveType:
      enum:
        - CONTINUE
        - RESTART_RUN
        - FINISH_RUN
        - CANCEL
      title: IterationDirectiveType
      type: string
    PublicIterationPendingCall:
      properties:
        call_id:
          title: Call Id
          type: string
        tool_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Tool Name
      required:
        - call_id
        - tool_name
      title: PublicIterationPendingCall
      type: object
    IterationPauseStatus:
      enum:
        - AWAITING_DIRECTIVE
        - DIRECTIVE_RECEIVED
        - RESUMED
        - ABANDONED
      title: IterationPauseStatus
      type: string
    IterationPauseTrigger:
      enum:
        - EVERY_STEP
        - RUN_COMPLETE
      title: IterationPauseTrigger
      type: string
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
  securitySchemes:
    bearerAuth:
      description: >-
        `Authorization: Bearer <token>` where `<token>` is either a
        `neo_sk_<env>_<secret>` API key (service account) or a Microsoft Entra
        ID access token (dashboard user).
      scheme: bearer
      type: http

````