Authorization
Your Narada API key for authentication. See Authentication for how to obtain your key.
Must be set to
application/json.Body
The natural language instruction for the task to execute.
When using the Python SDK’s
agent() method, the /Operator prefix is added automatically. When calling the REST API directly, prefix your prompt with /Operator to use the web automation agent, or omit it for the Generalist agent.Unique identifier for the specific browser window to target. Required for
"client" execution mode. See Authentication for more information.How the task should be executed. Possible values:
"client": Runs in a browser window with the Narada extension installed (requiresbrowserWindowId)"cloud": Runs server-side without a browser"cloud_browser": Creates a fresh Cloud Browser Session and runs the task in it (no extension needed)
Whether to clear the chat history before executing the command. Set to
false to continue a previous conversation.Link this request to a previous one for conversation continuity. When set, the agent retains context from the previous request.
Whether to capture an animated GIF of the automation process. When enabled, the GIF is automatically saved to the
Narada Downloads directory. Learn more about Action Trace.Specify structured output format using JSON Schema. See Structured Output documentation for detailed examples.
File attachments to provide to the agent. Each attachment is an object with a
key field (obtained from the file upload endpoint).The timezone for any time-related operations in the automation task.
MCP (Model Context Protocol) servers to connect during task execution. Each server provides additional tools the agent can use. See A2A and MCP.
Variables for secure substitution in prompts. Use
${variable_name} syntax in your prompt. Values are substituted after the LLM plans its actions, so the LLM never sees the actual values. Ideal for passwords, API keys, and sensitive data.Input variables passed to custom agents. These are visible to the agent and accessible in custom agent workflows via the
variables dictionary. See Input Variables.Webhook URL to receive the response asynchronously when the task completes. See Webhooks documentation.
A secret key included in the webhook payload body for verification. Use this to validate that webhook requests are genuinely from Narada.
HTTP headers to include when sending the webhook POST request to your
callbackUrl.If
true, the API blocks until the task completes and returns the full response inline (instead of returning just a requestId). Useful for simple scripts. Returns 408 if the task times out.Optional label for the cloud browser session. Only used when
executionMode is "cloud_browser".Response
Unique identifier for tracking the request. Use this ID for: - Polling the
status via GET /responses/ -
Correlating webhook responses - Debug and monitoring purposes
202 ACCEPTED immediately while the automation task runs in the background. Use the requestId to track progress through polling or webhooks.
Example Commands
Best Practices
- Use Browser Window IDs to target specific browser contexts when working with multiple windows
- Implement timeouts for long-running automation tasks
- Use webhooks for better performance with asynchronous processing
- Test with simple commands before implementing complex workflows
- Enable GIF generation for debugging complex automation sequences