Poll a batch job

get/v1/batches/{id}

Request

  • Base URL: https://api.serpkite.com
  • URL: https://api.serpkite.com/v1/batches/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

OK

idstring uuid required
status'queued' | 'running' | 'done' | 'failed' required
endpointstring required
created_atstring date-time required
completed_atstring date-time nullable
credits_usednumber
poll_urlstring required
webhook_urlstring nullable
webhook_status'pending' | 'delivered' | 'failed' | 'null' nullable
resultobject nullable

Present when done; kept 24h. The endpoint's response body, or {markdown, meta} for format=markdown jobs

Example response

{
  "endpoint": "/v1/search"
}

Changes

No recorded changes to this operation across all 1 revision of this API.