A company's whole pre-action brief in one call

The motion atoms + history primitives pre-joined into one bounded, compact call -- an agent's whole pre-action context in one round-trip instead of five. Honors max_age (seconds); cold returns 202 {job_id, status: "crawling"}, same as hiring-pulse.

Requires the read scope.

get/v1/companies/{company_id}/pre-action-brief

Request

  • Base URL: https://api.reqbeat.com
  • URL: https://api.reqbeat.com/v1/companies/{company_id}/pre-action-brief
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

company_idinteger required

The plane's company id -- returned as company_id by /v1/reqs/search and by every company motion response.

Query parameters

max_ageinteger nullable

Maximum acceptable data age in SECONDS for the underlying hiring signals the brief is assembled from.

Headers

Idempotency-Keystring nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.