> ## 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.

# GetHeartbeatAPI mirrors the erdo_get_heartbeat MCP tool.




## OpenAPI

````yaml /api/openapi.json get /v1/heartbeats/{heartbeatID}
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, experiments, and bounded outreach.
    Authenticate with a Bearer API key (erdo_api_...) or scoped token
    (erdo_token_...).
  version: '2026-11-21'
servers:
  - url: https://api.erdo.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/heartbeats/{heartbeatID}:
    get:
      summary: |
        GetHeartbeatAPI mirrors the erdo_get_heartbeat MCP tool.
      operationId: GET:mcp.GetHeartbeatAPI
      parameters:
        - allowEmptyValue: true
          explode: false
          in: path
          name: heartbeatID
          required: true
          schema:
            type: string
          style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  active_days:
                    items:
                      format: int64
                      type: integer
                    type: array
                  active_window_end:
                    type: string
                  active_window_start:
                    type: string
                  agent_key:
                    description: |
                      scripted automations.
                    title: >
                      AgentKey is the persisted executor for agent automations;
                      it is empty for
                    type: string
                  anchor_time:
                    title: >
                      AnchorTime is the clock time ("HH:MM") runs land on, in
                      Timezone.
                    type: string
                  conversation:
                    type: string
                  created_at:
                    type: string
                  cron_expression:
                    type: string
                  description:
                    type: string
                  effort:
                    title: >
                      Effort is the stored reasoning effort; empty means the
                      executor default.
                    type: string
                  ends_at:
                    type: string
                  id:
                    format: uuid
                    type: string
                  instructions:
                    title: >
                      Instructions is the agent automation's prompt; empty for a
                      scripted one.
                    type: string
                  interval_minutes:
                    format: int64
                    type: integer
                  kind:
                    description: >
                      "script" (a deterministic zero-LLM JS body runs each
                      tick). It tells a caller which body field a read carries
                      and which one an update should send: instructions for an
                      agent automation, script\_js for a scripted one.
                    title: >
                      Kind is "agent" (an LLM runs each tick, driven by
                      instructions) or
                    type: string
                  latest_execution:
                    $ref: '#/components/schemas/mcp.MCPExecution'
                  latest_status:
                    type: string
                  model:
                    title: >
                      Model is the LLM the automation's runs use; empty means
                      the executor default.
                    type: string
                  name:
                    type: string
                  next_run_at:
                    type: string
                  persona_id:
                    format: uuid
                    type: string
                  run_after_delay_minutes:
                    format: int64
                    type: integer
                  run_after_id:
                    title: >
                      RunAfterID is the automation this one follows. Empty means
                      no chain.
                    type: string
                  run_after_on_success:
                    type: boolean
                  run_after_replaces_schedule:
                    type: boolean
                  run_at:
                    description: |
                      automation has none.
                    title: >
                      RunAt and EndsAt are the declared bounds, RFC3339 in UTC;
                      absent when the
                    type: string
                  schedule_triggers:
                    items:
                      $ref: '#/components/schemas/types.CronScheduleInfo'
                    type: array
                  script_js:
                    description: >
                      Present on a read so a caller can read-modify-write the
                      script.
                    title: >
                      ScriptJS is the scripted automation's JS body; empty for
                      an agent one.
                    type: string
                  state:
                    type: string
                  thread_id:
                    type: string
                  timezone:
                    type: string
                type: object
          description: Success response
        default:
          $ref: '#/components/responses/APIError'
components:
  schemas:
    mcp.MCPExecution:
      properties:
        completed_at:
          type: string
        error_message:
          type: string
        failure_class:
          description: |
            the task; ErrorMessage is then its reason.
          title: >
            FailureClass is "reported_could_not" when the run said it could not
            do
          type: string
        id:
          format: uuid
          type: string
        result:
          type: object
          nullable: true
        started_at:
          type: string
        status:
          type: string
        thread_id:
          format: uuid
          type: string
      type: object
    types.CronScheduleInfo:
      properties:
        cron_expression:
          type: string
        enabled:
          type: boolean
        ends_at:
          format: date-time
          type: string
        next_run_at:
          format: date-time
          type: string
        run_at:
          format: date-time
          type: string
        timezone:
          type: string
        trigger_id:
          format: uuid
          type: string
      title: |
        CronScheduleInfo is the readable schedule of one existing trigger.
      type: object
  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_...).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.