Skip to main content

​
1. Get Your API Key

Create an organization and get an API key from the dashboard. Store the key securely — it is only shown once.

​
2. Create a Portal

Define what you want to automate: 
curl -X POST https://agent.usedari.com/portals/$ORG_ID \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint_name": "contact_form",
    "start_url": "https://example.com/contact",
    "task": "Fill out the contact form with the provided data",
    "form_schema": {
      "type": "object",
      "properties": {
        "name": {"type": "string"},
        "email": {"type": "string"},
        "message": {"type": "string"}
      },
      "required": ["name", "email", "message"]
    }
  }'

​
3. Start a Job

Submit data to be filled by the AI agent: 
curl -X POST https://agent.usedari.com/jobs/$ORG_ID/contact_form/start \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "form_data": {
      "name": "Jane Smith",
      "email": "jane@example.com",
      "message": "Hello from the API!"
    },
    "orchestrator_model": "claude-sonnet-4-6",
    "vision_model": "openai:gpt-5.4-mini",
    "human_in_the_loop": false,
    "max_turns": 50,
    "timeout_minutes": 30
  }'
The response includes a job_id. Poll the status endpoint to get the browser_url once the session is created. Allowed vision_model values on this branch are openai:gpt-5.4, openai:gpt-5.4-mini, anthropic:claude-haiku-4-5-20251001, and kimi:moonshotai/Kimi-K2.5.

​
4. Track Progress

Poll for status updates: 
curl "https://agent.usedari.com/jobs/$ORG_ID/contact_form/status?job_id=$JOB_ID" \
  -H "X-API-Key: $API_KEY"
Or stream real-time logs via SSE: 
curl -N "https://agent.usedari.com/jobs/$ORG_ID/contact_form/logs?job_id=$JOB_ID" \
  -H "X-API-Key: $API_KEY"

​
Job Lifecycle

pending -> running -> completed
                   -> failed
           running -> paused -> running (resumed)
                   -> stopped
Jobs consume credits from your organization’s balance. You can view your balance on the dashboard.