{"id":"queue.consume","module":"scheduling","namespace":"queue","action":"consume","method":"POST","path":"/v1/queue/consume","idempotent":false,"available":true,"vendors":[],"vendors_ready":[],"vendors_pending":[],"key_status":"live","default_vendor":null,"self_hosted":true,"minimum_tier":"standard","supported_message_classes":null,"regions":["western","china"],"dynamic_params":{},"models_tracked":false,"sdk_hint":"Regular parameters + types are stable — read them from the typed SDK signature / API reference for this capability. discovery only carries the runtime-dynamic values above (available, vendors, dynamic_params).","params":{"title":"QueueConsumeRequest","description":"Request shape for queue.consume — lease-based pull (maps module poll). Non-idempotent: each call leases a different batch. See REVIEW Scheduling §3.B.","type":"object","required":["queue"],"additionalProperties":false,"properties":{"queue":{"type":"string","description":"Queue name this message or subscription belongs to"},"max_messages":{"type":"integer","minimum":1,"maximum":10,"default":10,"description":"Maximum number of messages to consume in one batch"},"visibility_timeout":{"type":["integer","null"],"minimum":0,"maximum":43200,"description":"Lease seconds; defaults to queue's visibility_timeout_default."}}},"response":{"title":"QueueMessageList","description":"Result for queue.consume and queue.dlq.list — array of QueueMessage rows. consume uses lease semantics (no cursor); dlq.list uses cursor pagination. See REVIEW Scheduling §3.B.","type":"object","required":["items"],"additionalProperties":false,"properties":{"items":{"type":"array","items":{"title":"QueueMessage","type":"object","description":"Superset shape: full message (queue.publish / queue.consume / queue.dlq.list) plus the thin ack/nack confirmation (queue.ack / queue.nack only return message_id + acked/nacked[+requeue]).","required":["message_id"],"additionalProperties":false,"properties":{"message_id":{"type":"string","pattern":"^qmsg_[A-Za-z0-9]{20,}$","description":"Unique identifier for this message"},"queue":{"type":"string","description":"Queue name this message or subscription belongs to"},"acked":{"type":"boolean","description":"Whether the message was acknowledged (queue.ack response)"},"nacked":{"type":"boolean","description":"Whether the message was rejected (queue.nack response)"},"requeue":{"type":"boolean","description":"Whether the rejected message was requeued (queue.nack response)"},"account_id":{"type":"string","description":"Account identifier that owns this resource"},"payload":{"type":"object","description":"Payload data for the message or request body"},"headers":{"type":["object","null"],"description":"Custom HTTP headers to include in requests or responses"},"status":{"enum":["available","in_flight","deleted","dlq"],"description":"Current status of this resource"},"delivery_count":{"type":"integer","minimum":0,"description":"Number of delivery attempts for this message"},"visibility_timeout_expires_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp when visibility timeout expires"},"published_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the event was published"},"available_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the message becomes available for consumption"},"priority":{"type":"integer","minimum":0,"maximum":10,"default":0,"description":"Priority for MX or SRV records"},"message_group_id":{"type":["string","null"],"description":"FIFO only."},"deduplication_id":{"type":["string","null"],"description":"FIFO only; 5-min dedup window."}}},"description":"Array of result items in this page"},"next_cursor":{"type":["string","null"],"description":"Opaque cursor to fetch the next page; null/absent if this is the last page"}}},"errors":["ACCOUNT_AUTORECHARGE_LIMIT","ACCOUNT_FROZEN","AUTH_RATE_LIMIT","AUTH_REFRESH_TOO_FREQUENT","CRON_EXPR_INVALID","CRON_JOB_NOT_FOUND","CRON_MAX_RUNS_REACHED","CRON_MISSED_SCHEDULE","CRON_OVERLAP_SKIPPED","CRON_RUN_FAILED","CRON_RUN_TIMEOUT","CRON_TASK_5XX","CRON_TASK_URL_UNREACHABLE","CRON_TIMEOUT","CRON_TIMEZONE_INVALID","DEDUPLICATION_ID_MISSING","IDEMPOTENCY_KEY_CONFLICT","INSUFFICIENT_CREDIT","INTERNAL_ERROR","INVALID_ARGUMENT","KEY_REVOKED","MAINTENANCE","MESSAGE_GROUP_ID_MISSING","NETWORK_ERROR","QUEUE_ALREADY_EXISTS","QUEUE_DELAY_INVALID","QUEUE_FIFO_CONFLICT","QUEUE_HEADERS_TOO_LARGE","QUEUE_MESSAGE_NOT_FOUND","QUEUE_MESSAGE_NOT_IN_FLIGHT","QUEUE_MESSAGE_TOO_LARGE","QUEUE_NOT_FOUND","RATE_LIMIT_ACCOUNT","RATE_LIMIT_USER","RATE_LIMIT_VENDOR","SCOPE_INSUFFICIENT","UNAUTHORIZED","VENDOR_AUTH_ERROR","VENDOR_DOWN","VENDOR_TIMEOUT","WALLET_EXPIRED","WEBHOOK_DELIVERY_NOT_FOUND","WEBHOOK_ENDPOINT_NOT_FOUND","WEBHOOK_PAYLOAD_TOO_LARGE","WEBHOOK_TARGET_4XX","WEBHOOK_TARGET_5XX","WEBHOOK_TARGET_TIMEOUT","WEBHOOK_TIMESTAMP_EXPIRED","WEBHOOK_URL_INVALID","WEBHOOK_VERIFY_FAILED"],"examples":{"curl":"curl -X POST https://api.infrai.cc/v1/queue/consume \\\n  -H \"Authorization: Bearer $INFRAI_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"queue\": \"sample\"}'","python":"# Zero-install REST call — no SDK required (short-term the API is REST-only).\nimport os, requests\n\nresp = requests.post(\n    \"https://api.infrai.cc/v1/queue/consume\",\n    headers={\n        \"Authorization\": f\"Bearer {os.environ['INFRAI_API_KEY']}\",\n    },\n    json={'queue': 'sample'},\n)\nresp.raise_for_status()\nprint(resp.json())","javascript":"// Zero-install REST call — no SDK required (short-term the API is REST-only).\nconst resp = await fetch(\n  \"https://api.infrai.cc/v1/queue/consume\",\n  {\n    method: \"POST\",\n    headers: {\n      \"Authorization\": `Bearer ${process.env.INFRAI_API_KEY}`,\n      \"Content-Type\": \"application/json\",\n    },\n    body: JSON.stringify({\"queue\": \"sample\"}),\n  },\n);\nconsole.log(await resp.json());","typescript":"// Zero-install REST call — no SDK required (short-term the API is REST-only).\nconst resp = await fetch(\n  \"https://api.infrai.cc/v1/queue/consume\",\n  {\n    method: \"POST\",\n    headers: {\n      \"Authorization\": `Bearer ${process.env.INFRAI_API_KEY}`,\n      \"Content-Type\": \"application/json\",\n    },\n    body: JSON.stringify({\"queue\": \"sample\"}),\n  },\n);\nif (!resp.ok) throw new Error(`infrai ${resp.status}`);\nconst data: unknown = await resp.json();\nconsole.log(data);","go":"// Zero-install REST call — no SDK required (short-term the API is REST-only).\npackage main\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"os\"\n)\n\nfunc main() {\n\tbody := []byte(`{\"queue\": \"sample\"}`)\n\treq, _ := http.NewRequest(\"POST\", \"https://api.infrai.cc/v1/queue/consume\", bytes.NewReader(body))\n\treq.Header.Set(\"Authorization\", \"Bearer \"+os.Getenv(\"INFRAI_API_KEY\"))\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\tresp, err := http.DefaultClient.Do(req)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n\tdefer resp.Body.Close()\n\tfmt.Println(resp.Status)\n}","java":"// Zero-install REST call — no SDK required (short-term the API is REST-only).\nimport java.net.URI;\nimport java.net.http.*;\n\nHttpRequest req = HttpRequest.newBuilder()\n    .uri(URI.create(\"https://api.infrai.cc/v1/queue/consume\"))\n    .header(\"Authorization\", \"Bearer \" + System.getenv(\"INFRAI_API_KEY\"))\n    .header(\"Content-Type\", \"application/json\")\n    .method(\"POST\", HttpRequest.BodyPublishers.ofString(\"{\\\"queue\\\": \\\"sample\\\"}\"))\n    .build();\nHttpResponse<String> resp = HttpClient.newHttpClient()\n    .send(req, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(resp.body());","csharp":"// Zero-install REST call — no SDK required (short-term the API is REST-only).\nusing System;\nusing System.Net.Http;\n\nvar client = new HttpClient();\nvar req = new HttpRequestMessage(new HttpMethod(\"POST\"), \"https://api.infrai.cc/v1/queue/consume\");\nvar key = Environment.GetEnvironmentVariable(\"INFRAI_API_KEY\");\nreq.Headers.Add(\"Authorization\", \"Bearer \" + key);\nreq.Content = new StringContent(\"{\\\"queue\\\": \\\"sample\\\"}\", System.Text.Encoding.UTF8, \"application/json\");\nvar resp = await client.SendAsync(req);\nConsole.WriteLine(await resp.Content.ReadAsStringAsync());","php":"<?php\n// Zero-install REST call — no SDK required (short-term the API is REST-only).\n$ch = curl_init(\"https://api.infrai.cc/v1/queue/consume\");\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, \"POST\");\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n    \"Authorization: Bearer \" . getenv(\"INFRAI_API_KEY\"),\n    \"Content-Type: application/json\",\n]);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, \"{\\\"queue\\\": \\\"sample\\\"}\");\n$response = curl_exec($ch);\ncurl_close($ch);\necho $response;","ruby":"# Zero-install REST call — no SDK required (short-term the API is REST-only).\nrequire \"net/http\"\nrequire \"uri\"\n\nuri = URI(\"https://api.infrai.cc/v1/queue/consume\")\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nreq = Net::HTTP::Post.new(uri)\nreq[\"Authorization\"] = \"Bearer #{ENV['INFRAI_API_KEY']}\"\nreq[\"Content-Type\"] = \"application/json\"\nreq.body = '{\"queue\": \"sample\"}'\nres = http.request(req)\nputs res.body","rust":"// Zero-install REST call — no SDK required (short-term the API is REST-only). (uses the reqwest + tokio crates)\nuse std::env;\n\n#[tokio::main]\nasync fn main() -> Result<(), Box<dyn std::error::Error>> {\n    let resp = reqwest::Client::new()\n        .post(\"https://api.infrai.cc/v1/queue/consume\")\n        .header(\"Authorization\", format!(\"Bearer {}\", env::var(\"INFRAI_API_KEY\")?))\n        .header(\"Content-Type\", \"application/json\")\n        .body(r#\"{\"queue\": \"sample\"}\"#)\n        .send()\n        .await?;\n    println!(\"{}\", resp.text().await?);\n    Ok(())\n}","request":{"queue":"sample"}},"billing":{"is_billable":false,"free":true,"billing_class":"self_dev_market","unit":"per_call","note":"free (rate-limited); does NOT consume the new-account trial"}}