Get a request

Changed on

Inspect a customer-owned Request. Poll queued or running requests after retryAfterSeconds; a durable result stays collectable for 24 hours. A paid request's output can be read back for the account's response retention window, 3 days unless 7 days or none is chosen in the dashboard; lowering the setting hides older output at once. Reading kept output is limited per account to 30 reads a minute for each dollar of lifetime settled spend, so an account that has spent nothing cannot read it. Metadata remains after the result expires (resultExpired).

get/v1/requests/{id}

Request

  • Base URL: https://api.getanyapi.com
  • URL: https://api.getanyapi.com/v1/requests/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring uuid required

Response

Current request snapshot.

completedAtstring date-time
createdAtstring date-time required
expiresAtstring date-time
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