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

# ArmWorkstreamLoopAPI mirrors erdo_arm_workstream_loop: schedule the recurring


> allocator reconciliation pass for a workstream.




## OpenAPI

````yaml /api/openapi.json post /v1/workstreams/{workstreamSlug}/arm
openapi: 3.0.0
info:
  title: Erdo API
  description: >-
    Erdo's REST API: query and write datasets, run agents, manage threads,
    integrations, pages, evals, workstreams, and experiments. Authenticate with
    a Bearer API key (erdo_api_...) or scoped token (erdo_token_...).
  version: '2026-07-25'
servers:
  - url: https://api.erdo.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/workstreams/{workstreamSlug}/arm:
    post:
      summary: >
        ArmWorkstreamLoopAPI mirrors erdo_arm_workstream_loop: schedule the
        recurring
      description: |
        allocator reconciliation pass for a workstream.
      operationId: POST:mcp.ArmWorkstreamLoopAPI
      parameters:
        - allowEmptyValue: true
          explode: false
          in: path
          name: workstreamSlug
          required: true
          schema:
            type: string
          style: simple
      requestBody:
        content:
          application/json:
            schema:
              properties:
                interval_minutes:
                  format: int64
                  type: integer
                model:
                  type: string
                timezone:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  heartbeat_id:
                    format: uuid
                    type: string
                  interval_minutes:
                    format: int64
                    type: integer
                  message:
                    type: string
                  model:
                    type: string
                  next_run_at:
                    type: string
                  reused:
                    description: >
                      reconfigured it rather than creating a second heartbeat.
                      Arming is idempotent: one workstream has at most one
                      reconciliation loop.
                    title: >
                      Reused is true when arming found an existing loop for the
                      workstream and
                    type: boolean
                  workstream_slug:
                    type: string
                  workstream_title:
                    type: string
                type: object
          description: Success response
        default:
          $ref: '#/components/responses/APIError'
components:
  responses:
    APIError:
      content:
        application/json:
          schema:
            externalDocs:
              url: https://pkg.go.dev/encore.dev/beta/errs#Error
            properties:
              code:
                description: Error code
                example: not_found
                externalDocs:
                  url: https://pkg.go.dev/encore.dev/beta/errs#ErrCode
                type: string
              details:
                description: Error details
                type: object
              message:
                description: Error message
                type: string
            title: APIError
            type: object
      description: Error response
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

````