API Documentation
The Aiqaramba API lets you create and manage autonomous browser agents, organize work into projects, define reusable journeys, run experiments, and more. All endpoints use JSON and require Bearer token authentication.
Authentication
All API requests require a Bearer token in the Authorization header. You can create API keys from your Account page.
Authorization: Bearer YOUR_API_KEY
Base URL
Resources
Agents
Agents are autonomous browser-based workers that execute prompts against a target website. Each agent gets its own browser session, follows the instructions in its prompt, and reports back with results.
9 endpointsProjects
Projects are containers that organize agents, journeys, and experiments. Every agent must belong to a project.
4 endpointsJourneys
Journeys are reusable, parameterized agent templates. Define a prompt template using Go text/template syntax, add checkpoints for progress tracking, and set success criteria — then run the journey repeatedly with different inputs or personas.
6 endpointsExperiments
Experiments execute a matrix of journeys, personas, and browser types. The system computes the cartesian product and spawns one agent per combination, letting you compare results across all dimensions in a single run.
10 endpointsPersonas
Personas define user archetypes that agents can embody. The persona description is injected verbatim into the agent's LLM system prompt, directly shaping how the agent interacts with the target site.
4 endpointsEvent Schemas
Event schemas define the analytics events that should be tracked during agent sessions. Attach a schema to an experiment to verify that the correct events fire during user journeys.
5 endpointsLLM-Ready Reference
Copy the entire API reference as plain-text markdown — paste it into ChatGPT, Claude, or any LLM to let it write API calls for you. Also available at /docs/llm.txt.