Skip to content
Documentation/Documents

Get a document answer

Poll a queued document question for its status and checked result.

Markdown
GET/api/v1/ask/{id}https://api.webcite.co

When to use it

Keep the ID returned by Ask a document. Poll with a delay and a bounded timeout. Stop polling on done or failed.

Request

0 credits.

Examples run on your server. Set WEBCITE_API_KEY first. Python examples use the requests package.

curl
curl --fail-with-body -X GET 'https://api.webcite.co/api/v1/ask/YOUR_ID' \
  -H "x-api-key: $WEBCITE_API_KEY"

Path and query parameters

id (path)stringrequired

Ask job ID

No request body is required.

Response

Status is queued, running, done, or failed. When done, inspect the result and warnings; a completed job can still have a null answer.

200 response

See the response guidance above. A complete JSON schema is not published for this response.

Errors

For 400, check the request fields and source identifiers. For 401, check your API key. For 429, wait for the retry interval. See the errors guide before retrying a billable request.

401
Unauthorized - API key required
404
Ask job not found.
Error handling and retry guidance