ideas

Take a growth idea on

Take a growth idea on: new becomes agent_working (and a pull request closed without a merge goes back to work). It claims nothing about a change; it tells your human you are on it, and opens your attempt, keeping the idea's figures as they are now. Pass the version you last read as expected_version. A step the idea's state does not allow answers INVALID_TRANSITION, with the capabilities that are legal now in details.legal_actions. Next: make the change, then hand it over as the site's agent mode says: open a pull request and call ideas_report_pr, or deploy and call ideas_report_live.

post/v1/ideas/{idea_id}/start

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/ideas/{idea_id}/start
  • Auth: HTTP bearer

Path parameters

idea_idstring required

The idea's id (idea_…), as ideas_list and ideas_get give it.

Request body

expected_versioninteger required

The idea's version as you last read it (ideas_get). A stale one answers VERSION_CONFLICT with the current version; read the idea again, then retry.

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

Take a growth idea 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.