Effects

Look up an effect by type and idempotency key

A free, non-metered read. Useful for reconciling state after a crash without consuming allowance.

get/v1/effects/lookup

Request

  • Base URL: https://ratchetgate.com
  • URL: https://ratchetgate.com/v1/effects/lookup
  • Auth: HTTP bearer

Query parameters

effect_typestring required
idempotency_keystring required

Response

Default Response

effect_idstring
effect_typestring
idempotency_keystring
statestring
attemptinteger
resultunknown
failure_reasonstring nullable
denial_reasonstring nullable
agent_idstring nullable
run_idstring nullable
estimated_cost_microsinteger
actual_cost_microsinteger
lease_expires_atstring nullable
approval_statestring nullable
created_atstring
updated_atstring
settled_atstring nullable

Changes

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