Authorization
Your Narada API key for authentication. Contact support to obtain your API
key.
Must be set to
application/json
.Body
The natural language instruction for the task to execute. Must be prefixed
with
/Operator
to invoke the web agent.Unique identifier for the specific browser window to target. Please see
authentication for more information.
Whether to clear the chat history before executing the command. Recommended
for isolated tasks.
Whether to capture an animated GIF of the automation process. When enabled,
the GIF is automatically saved to your local
Narada Downloads
directory.
Learn more about GIF generation.Specify structured output format using JSON Schema. See JSON Schema documentation for detailed examples.
Optional webhook URL to receive the response asynchronously. Recommended for
long-running tasks. See Webhooks documentation.
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
Command Prefix: Always prefix automation commands with
/Operator
to
invoke the web agent. Commands without this prefix will not be processed.Descriptive Prompts: Be specific about your intentions. Instead of
/Operator click button
, use /Operator click the Submit button in the contact form
.- 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