Plan Management

Endpoints

Initiate Plan

POST /api/robots/plan/initiate

Initiates a remote Scrapybara instance for a specified plan.

Request Body:

• instance_plan_id (string, UUID, required): The ID of the plan to initiate.

Execute Plan Step

POST /api/robots/plan/act

Executes plan steps on a robot instance. Handles plan execution, tool validation, and step updates.

Request Body:

• instance_id (string, UUID, required): The ID of the instance.
• instance_plan_id (string, optional): The ID of the plan.
• user_instruction (string, optional): Specific instruction for the step.

Stop Plan

POST /api/robots/plan/stop

Pauses the remote instance and leaves the plan pending for later resumption.

Request Body:

• instance_id (string, UUID, required): The ID of the instance.

Verify Plan

POST /api/robots/plan/verify

Retrieves logs and takes a screenshot to verify instance progress.

Request Body:

• instance_id (string, UUID, required): The ID of the instance.
• instance_plan_id (string, UUID, required): The ID of the plan.