Skip to main content
POST
Report a run of a step that was cut off, and ask what to do with the step

Authorizations

X-API-Key
string
header
required

Path Parameters

action_id
string<uuid>
required

Body

application/json

A run of the held step cut off without an error from LinkedIn, reported instead of a result.

The same report again (the same stopped_run_id) gets the same answer and changes nothing, so a report that got no answer is sent again with the same ids until it does.

cause
enum<string>
required

Why the run stopped: person_closed (a person closed the working tab), worker_restarted, page_not_loaded, tab_frozen, identity_no_answer, or outage (the server could not be asked). Every cause but person_closed and outage counts against the step.

Available options:
person_closed,
worker_restarted,
page_not_loaded,
tab_frozen,
identity_no_answer,
outage
claimed_at
string<date-time>
required

The step's claim, exactly as the claim handed it out.

next_run_id
string
required

The run the step goes on in, named by this browser before it reports.

Required string length: 8 - 64
Pattern: ^[A-Za-z0-9_-]+$
stopped_run_id
string
required

The run that stopped: the one the press fence may name.

Required string length: 8 - 64
Pattern: ^[A-Za-z0-9_-]+$
duration_ms
integer | null

How long the stopped run lasted.

Required range: x >= 0
site
string | null

Where the run stopped, a failure_sites.json name; null for an outage.

Pattern: ^[a-z][a-z0-9_]{0,63}$

Response

Successful Response

What the browser does with a step after one of its runs was cut off.

attempt
integer
required

Which attempt this was.

attempts_left
integer
required

How many counted attempts remain before the step stops.

claim_expires_at
string<date-time> | null
required

The claim's lease, extended, read against server_now; null unless it goes on.

next_run_id
string | null
required

The run that may press now; null unless the step goes on.

server_now
string<date-time>
required

The server's clock when it answered.

verdict
enum<string>
required

retry: run it again as next_run_id. look_first: run it again, looking on LinkedIn before any press (verification). stop: it was cut off too often and is settled failed; post nothing. lost: the claim is not this browser's any more; post nothing. not_retryable: the exit is not an interruption; post the result.

Available options:
retry,
look_first,
stop,
lost,
not_retryable
verification
AgentAttemptVerificationSchema · object | null
required

For look_first: what to look for before acting; null otherwise.