discovery-runs

Heartbeat a discovery job

Changed on

Renew a Scout worker lease and store progress for a claimed discovery job.

Use this discovery operation to create, synchronize, lease, inspect, or cancel research work. Treat discovered actors as reviewable leads until their source evidence and visibility state are checked.

post/api/discovery-runs/jobs/{job_id}/heartbeat

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/discovery-runs/jobs/{job_id}/heartbeat
  • Auth: none declared

Path parameters

job_idstring required

Headers

x-api-keystring nullable

Request body

lease_secondsinteger

Renewed lease duration

progressobject

Worker progress

worker_idstring required

Enrolled Scout device id

Response

Successful Response

claimed_bystring nullable

Worker that claimed the job

claimed_untilstring nullable

Current worker lease expiration

completed_atstring nullable

Completion timestamp

created_atstring required

Creation timestamp

error_messagestring nullable

Error message if failed

execution_mode'search' | 'direct_url'

How a Scout worker should execute this job

idstring required

Job ID

input_payloadobject

Mode-specific worker input payload

issue_areasstring[] required

Run issue area slugs

location_querystring required

Run location query

max_retriesinteger

Maximum retry attempts before permanent failure

next_attempt_atstring nullable

Earliest retry claim timestamp

progressobject nullable

Current step and metrics

research_goalstring required

Research job this run supports

retry_countinteger

Number of retry attempts so far

run_idstring required

Associated discovery run ID

started_atstring nullable

Execution start timestamp

statestring required

Run state

statusstring required

Job status (queued, claimed, running, completed, failed)

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id