GEgetanyapi-com

Collect a charged request

Read one charged, still-running Request through the collectUrl it was given, with no API key. Wait Retry-After seconds between reads until status is succeeded; the answer is in result.output. The link stops working once the request is gone or its connection was revoked.

get/v1/requests/{id}/collect

Request

Path parameters

idstring uuid required

Query parameters

tokenstring required

Response

Current request snapshot.

collectUrlstring

Present while a charged request is still running: a link that reads this one request with no API key, so whoever holds it can collect the answer. Read it no faster than Retry-After.

completedAtstring date-time
costUsdnumber

What a request with no result yet, or a failed one, was already charged in USD. Some lookups are charged as soon as they start and are never charged again or refunded; a result states its own cost.

createdAtstring date-time required
expiresAtstring date-time
notestring

How to finish a charged request that is still running; present with collectUrl.

requestIdstring uuid required
resultExpiredboolean
retryAfterSecondsinteger
serviceOutcome'served' | 'valid_negative' | 'caller_error' | 'service_failure' | 'rejected'

End-to-end AnyAPI service result when known; independent of payment settlement.

settlementState'not_required' | 'pending' | 'settled' | 'reconcile' | 'charged_undelivered' | 'writeoff'

Payment settlement state when known; independent of request lifecycle status.

skustring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'expired' required

Changes

No operation changes recorded.