WellMarked Docs
API referenceBulk Extraction

Poll the status of a bulk extraction job

Return the current state of a bulk job: status, how many URLs have completed out of total, and the results collected so far.

GET
/bulk/{job_id}

Return the current state of a bulk job: status, how many URLs have completed out of total, and the results collected so far.

Results stream in as they finish, so this is safe to poll while status is processing. Each result carries its own status, so check per item rather than assuming a finished job means every URL succeeded.

Jobs are scoped to the key that created them; polling someone else's job returns 403. Unmetered.

Authorization

BearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer wm_.... Keys are wm_ followed by 40 hex characters. Create one with POST /register (free, no auth) or POST /keys.

In: header

Path Parameters

job_id*Job Id
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.wellmarked.io/bulk/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer wm_your_api_key_here"
{  "completed": 0,  "created_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",  "kind": "bulk",  "results": [    {      "blocks": [        {          "level": 0,          "text": "string",          "type": "heading"        }      ],      "chunks": [        {          "end_token": 0,          "start_token": 0,          "text": "string"        }      ],      "error": "string",      "html": "string",      "links": [        "string"      ],      "markdown": "string",      "metadata": {        "author": "string",        "date": "string",        "retrieved_at": "2019-08-24T14:15:22Z",        "title": "string",        "url": "string"      },      "metrics": {        "content_bytes": 0,        "input_tokens": 0,        "output_tokens": 0,        "reduction_pct": 0,        "tokens_saved": 0      },      "url": "string"    }  ],  "status": "string",  "total": 0}