Instance Management
Endpoints
Create or Resume Instance
POST /api/robots/instance
Creates a new remote Scrapybara instance or resumes an existing one.
Request Body:
site_id(string, UUID, required): The ID of the site.activity(string, required): Description of the activity (min 3 chars).instance_id(string, UUID, optional): ID of an existing instance to resume.
Stop Instance
POST /api/robots/instance/stop
Stops and terminates a remote instance in Scrapybara.
Request Body:
instance_id(string, UUID, required): The ID of the instance to stop.
Pause Instance
POST /api/robots/instance/pause
Pauses a remote instance, saving its state for later resumption.
Request Body:
instance_id(string, UUID, required): The ID of the instance to pause.
Resume Instance
POST /api/robots/instance/resume
Resumes a paused instance or provisions a new one if needed.
Request Body:
instance_id(string, UUID, required): The ID of the instance to resume.timeout_hours(number, optional): Timeout in hours (0.1-24, default: 1).
Delete Instance
POST /api/robots/instance/delete
Stops the instance in Scrapybara and deletes the record from the database.
Request Body:
instance_id(string, UUID, required): The ID of the instance to delete.
Execute Action
POST /api/robots/instance/act
Updates a robot instance plan, allowing you to regenerate, modify, or continue existing plans.
Request Body:
instance_id(string, UUID, required): The ID of the instance.message(string, required): Instruction or message for the action.step_status(string, optional): Status of the step (‘completed’, ‘failed’, ‘in_progress’, ‘pending’).site_id(string, optional): The ID of the site.activity(string, optional): Activity description.user_id(string, UUID, optional): The ID of the user.context(string or object, optional): Additional context for the action.
Assistant Interaction
POST /api/robots/instance/assistant
Triggers the Vercel Workflow for execution. Can create uninstantiated instances or execute on existing ones.
Request Body:
instance_id(string, UUID, optional): The ID of the instance.message(string, required): The message or instruction for the assistant.site_id(string, optional): Required when creating a new instance.user_id(string, UUID, optional): The ID of the user.tools(array, optional): List of tools to use.use_sdk_tools(boolean, optional): Whether to use SDK tools (default: false).system_prompt(string, optional): Custom system prompt.