> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automindz.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Scrape your first company career page in under a minute

## 1. Trigger a career page scrape

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.automindz.co/v1/scrape-career-pages/async \
    -H "Authorization: Bearer <your-api-key>" \
    -H "Content-Type: application/json" \
    -d '{
      "company_url": "acme.com",
      "company_name": "Acme Corp"
    }'
  ```

  ```python Python theme={null}
  import httpx

  resp = httpx.post(
      "https://api.automindz.co/v1/scrape-career-pages/async",
      headers={"Authorization": "Bearer <your-api-key>"},
      json={
          "company_url": "acme.com",
          "company_name": "Acme Corp",
      },
  )
  data = resp.json()
  print(data["request_id"])
  ```
</CodeGroup>

Response:

```json theme={null}
{
  "request_id": "run_abc123xyz",
  "status": "QUEUED"
}
```

## 2. Poll for results

```bash theme={null}
curl "https://api.automindz.co/v1/scrape-career-pages/async/<request_id>?limit=25&offset=0" \
  -H "Authorization: Bearer <your-api-key>"
```

<Note>
  Poll every 15–30 seconds. Most scrapes complete within 2–5 minutes. Companies with large ATS-hosted job boards may take longer.
</Note>

## 3. Get the results

When `status` is `COMPLETED`, `result.jobs` holds one page of listings. Keep requesting the next
`offset` while `has_more` is `true` — `jobs_total` is how many jobs you can page through:

```json theme={null}
{
  "request_id": "run_abc123xyz",
  "status": "COMPLETED",
  "result": {
    "company": "Acme Corp",
    "url": "https://acme.com",
    "career_page_urls": ["https://jobs.lever.co/acme"],
    "pages_scraped": 3,
    "jobs_returned": 1,
    "jobs_total": 1,
    "jobs_filtered_out": 0,
    "limit": 25,
    "offset": 0,
    "has_more": false,
    "jobs": [
      {
        "job_title": "Senior Software Engineer",
        "location": "London, UK",
        "city": "London",
        "country": "United Kingdom",
        "job_type": "full-time",
        "remote_policy": "hybrid",
        "department": "Engineering",
        "salary_min": 90000,
        "salary_max": 120000,
        "salary_currency": "GBP",
        "salary_period": "annual",
        "min_years_of_experience": 5,
        "requirements": ["5+ years TypeScript", "React", "Node.js"],
        "job_url": "https://jobs.lever.co/acme/abc-123",
        "ats_system": "lever",
        "posted_at": "2026-05-01"
      }
    ]
  },
  "credits_consumed": 2.89,
  "credits_left": 185.89,
  "started_at": "2026-05-15T10:00:00Z",
  "finished_at": "2026-05-15T10:03:42Z"
}
```