Waits

Creating a Wait

Create a wait on an inbox to block until a matching email arrives. The API returns as soon as the condition is met or the timeout is reached.

curl -X POST https://agentinbox.in/api/v1/waits \
  -H "Authorization: Bearer $AgentInbox_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inboxId": "inb_123",
    "type": "otp",
    "timeoutSeconds": 120
  }'

const wait = await client.waits.create({
  inboxId: "inb_123",
  type: "otp",
  timeoutSeconds: 120,
});
 
if (wait.status === "completed") {
  console.log(wait.result?.value); // "123456"
}

wait = client.waits.create(
    inbox_id="inb_123",
    type="otp",
    timeout_seconds=120,
)
 
if wait.status == "completed":
    print(wait.result.value)  # "123456"

Canceling a Wait

Cancel an active wait if you no longer need it. This frees up resources and prevents unnecessary polling.

curl -X DELETE https://agentinbox.in/api/v1/waits/wait_789 \
  -H "Authorization: Bearer $AgentInbox_API_KEY"

await client.waits.cancel("wait_789");

Wait Types

AgentInbox supports several wait types that automatically match and extract data from incoming emails.

Wait Statuses

A wait can be in one of several statuses depending on whether the expected email arrived.

Next Steps