Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.zeroclick.am/llms.txt

Use this file to discover all available pages before exploring further.

When you activate a listing, the response may return before the seller’s endpoint finishes. If orderState is pending or running, poll until it reaches a terminal state.

​
Poll for results

curl https://api.zeroclick.am/v1/orders/ORDER_ID \
  -H "x-zam-api-key: zam_your_key_here"
Response (completed):
{
  "id": "ORDER_ID",
  "listingId": "LISTING_ID",
  "orderState": "completed",
  "result": {"forecast": "sunny, 72°F"},
  "startedAt": "2025-01-15T10:30:00Z",
  "completedAt": "2025-01-15T10:30:01Z"
}
Response (failed):
{
  "id": "ORDER_ID",
  "listingId": "LISTING_ID",
  "orderState": "failed",
  "errorMessage": "Upstream service returned 503",
  "startedAt": "2025-01-15T10:30:00Z",
  "completedAt": "2025-01-15T10:30:05Z"
}
Poll every 1–2 seconds. The seller’s endpoint has a 30-second timeout, so no order stays in running state indefinitely.

​
Order states

StateMeaningTerminal?
pendingOrder created, execution not yet startedNo
runningZAM is calling the seller’s endpointNo
completedSeller’s endpoint returned successfullyYes
failedSeller’s endpoint returned an error or timed outYes

​
List all orders

curl https://api.zeroclick.am/v1/orders \
  -H "x-zam-api-key: zam_your_key_here"