{"openapi":"3.1.0","info":{"title":"Cloudflare Queues (BYOK) API","version":"0.1.0","description":"Cloudflare Queues (BYOK) lets an AI assistant read your own Cloudflare Queues data through the Cloudflare Queues API with a key you supply (Cloudflare API token with Queues read permission). Read-only: 8 tools (list_queues, get_queue, list_consumers, get_consumer, get_queue_metrics, get_purge_status, list_event_subscriptions, get_event_subscription). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-cloudflare-queues.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-cloudflare-queues/docs"},"termsOfService":"https://connectorbay.com/byok-cloudflare-queues/terms"},"servers":[{"url":"https://byok-cloudflare-queues.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-cloudflare-queues/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_queues":{"post":{"operationId":"list_queues","summary":"List the queues of an account with creation date, jurisdiction, delivery settings and producer and consumer counts. Mess","description":"List the queues of an account with creation date, jurisdiction, delivery settings and producer and consumer counts. Messages are never read. Use for \"Which Cloudflare queues do I have and are any paused\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1; result_info.total_count says how many exist.","title":"Page"}},"required":["account_id"],"title":"list_queuesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_queue":{"post":{"operationId":"get_queue","summary":"Get one queue: settings (delivery delay, paused flag, retention), producers and consumers. Use for \"What are the setting","description":"Get one queue: settings (delivery delay, paused flag, retention), producers and consumers. Use for \"What are the settings of my queue jobs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"queue_id":{"description":"Queue id, as returned by list_queues.","maxLength":64,"title":"Queue Id","type":"string"}},"required":["account_id","queue_id"],"title":"get_queueArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_consumers":{"post":{"operationId":"list_consumers","summary":"List the consumers of a queue with script name, batch size, concurrency, retry settings and dead letter queue. Use for \"","description":"List the consumers of a queue with script name, batch size, concurrency, retry settings and dead letter queue. Use for \"Which worker consumes my queue jobs and with what batch size\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"queue_id":{"description":"Queue id, as returned by list_queues.","maxLength":64,"title":"Queue Id","type":"string"}},"required":["account_id","queue_id"],"title":"list_consumersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_consumer":{"post":{"operationId":"get_consumer","summary":"Get one queue consumer with script name, batch and retry settings. Use for \"Show the retry settings of queue consumer bc","description":"Get one queue consumer with script name, batch and retry settings. Use for \"Show the retry settings of queue consumer bc3a5d8f2e1a4c7d9e0f1a2b3c4d5e6f\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"queue_id":{"description":"Queue id, as returned by list_queues.","maxLength":64,"title":"Queue Id","type":"string"},"consumer_id":{"description":"Consumer id, as returned by list_consumers.","maxLength":64,"title":"Consumer Id","type":"string"}},"required":["account_id","queue_id","consumer_id"],"title":"get_consumerArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_queue_metrics":{"post":{"operationId":"get_queue_metrics","summary":"Get the backlog of a queue: number of messages, bytes waiting and the timestamp of the oldest message (milliseconds). Us","description":"Get the backlog of a queue: number of messages, bytes waiting and the timestamp of the oldest message (milliseconds). Use for \"How many messages are waiting in my queue jobs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"queue_id":{"description":"Queue id, as returned by list_queues.","maxLength":64,"title":"Queue Id","type":"string"}},"required":["account_id","queue_id"],"title":"get_queue_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_purge_status":{"post":{"operationId":"get_purge_status","summary":"Get the status of the last purge request of a queue (start time and completion). Use for \"Did the purge of my queue fini","description":"Get the status of the last purge request of a queue (start time and completion). Use for \"Did the purge of my queue finish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"queue_id":{"description":"Queue id, as returned by list_queues.","maxLength":64,"title":"Queue Id","type":"string"}},"required":["account_id","queue_id"],"title":"get_purge_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_event_subscriptions":{"post":{"operationId":"list_event_subscriptions","summary":"List event subscriptions that deliver events (for example Images events) into queues, with source, destination queue and","description":"List event subscriptions that deliver events (for example Images events) into queues, with source, destination queue and events. Use for \"Which event subscriptions feed my queues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"order":{"anyOf":[{"enum":["created_at","name","enabled","source"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort field.","title":"Order"},"direction":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction.","title":"Direction"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1; result_info.total_count says how many exist.","title":"Page"}},"required":["account_id"],"title":"list_event_subscriptionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_event_subscription":{"post":{"operationId":"get_event_subscription","summary":"Get one event subscription with source, destination queue, events and enabled flag. Use for \"Is event subscription image","description":"Get one event subscription with source, destination queue, events and enabled flag. Use for \"Is event subscription image-events enabled\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Cloudflare account id (32-character hex string shown in the dashboard URL, or from the Cloudflare connector's list_accounts).","maxLength":40,"title":"Account Id","type":"string"},"subscription_id":{"description":"Event subscription id, as returned by list_event_subscriptions.","maxLength":64,"title":"Subscription Id","type":"string"}},"required":["account_id","subscription_id"],"title":"get_event_subscriptionArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}