sessions

Check in with the task you are working on

Tell your human what you are doing: check in once at the start with a one-line task, and Frontshelf's Agents page shows it on this window, live. This window is you: your agent tool and the session you send on every call (send the same one from this conversation), never an argument. Name the site, and the issue when you work on one. Checking in again replaces the task and makes a finished window working again. Next: send a step with sessions_step at each meaningful step, and finish with sessions_finish when you are done. If any call answers AGENT_STOPPED, your human pressed Stop on this window: stop at once and tell them.

post/v1/sessions/checkin

Request

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

Request body

taskstring required

What you are working on, in one line of at most 200 characters, written for your human.

sitestring

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID. Optional: the site you work on.

issue_idstring

Optional: the issue you work on (iss_…), as issues_list gives it. Its site is the window's: leave site out, or name that same site.

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

Check in with the task you are working on

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.