sessions

Tell your human the step you just took

Post one line to this window on the Agents page at each meaningful step (what you changed, what you are about to check), so your human can follow along. A step is at most 200 characters, written for a person; the newest 200 are kept. Name the issue it is about with issue_id: your first step about an issue takes it on, opening your attempt (attempt) and keeping the work order as you read it; that step and the next ones about it stay on the attempt's record. Taking an issue on needs the issues:write scope, as every issue action does; a step without issue_id needs only sites:read. Check in first with sessions_checkin. If any call answers AGENT_STOPPED, your human pressed Stop on this window: stop at once and tell them.

post/v1/sessions/steps

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sessions/steps
  • Auth: HTTP bearer

Request body

textstring required

The step, in one line of at most 200 characters.

issue_idstring

Optional: the issue this step is about (iss_…). Never guessed: a step without it belongs to no issue.

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Tell your human the step you just took

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

Changes

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