---
title: "Get sitemap job status"
method: GET
path: "/sitemap/{jobId}"
tags: ["Sitemap"]
---

# Get sitemap job status

`GET /sitemap/{jobId}`

## Request

- Base URL: `https://request.usestring.ai/v1`
- URL: `https://request.usestring.ai/v1/sitemap/{jobId}`
- Auth: HTTP bearer

Return a sitemap job's status and progress. Poll it after approveSitemapJob until the status is `completed`, `failed`, `canceled` or `token_cap_exceeded`. Also served under `/map` with the same shapes.

## Response `200`

Status returned.

- SitemapJob: Job status. Extra fields depend on `status`: `awaiting_approval`: `estimatedCostUsd`. `running`: `pending`, `processed`. `completed`: `pagesProcessed`, plus `urls` (full results) shortly after completion or `finishedAt`. `failed`: `errorMessage`, `finishedAt`. `canceled` / `token_cap_exceeded`: `pending`, `processed`.
  - `jobId` string, required
  - `status` 'awaiting_approval' | 'running' | 'completed' | 'failed' | 'canceled' | 'token_cap_exceeded', required: Job status.
  - `estimatedCostUsd` string: Quoted cost in USD, as a decimal string.
  - `pending` integer: Queued URLs.
  - `processed` integer: URLs crawled so far.
  - `pagesProcessed` integer
  - `urls` unknown[]: Full results, on a completed job. Use GET /sitemap/{jobId}/urls to page through them.
    - unknown
  - `errorMessage` string: Why the job failed, for example `quote_expired`.
  - `finishedAt` string, date-time

## Other responses

- `401`: Missing or invalid Authorization header.
- `404`: Job not found or expired.
- `409`: Approval handoff incomplete (`partial_state`). Retry the approve call.

---

[API](https://skmtc.dev/usestring/apis/string-web-access-api.md) · [All operations](https://skmtc.dev/usestring/apis/string-web-access-api/llms.txt) · [OpenAPI document](https://skmtc.dev/usestring/apis/string-web-access-api/revisions/fd336960036e?raw)