API Reference

Queues

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Consumers

List Queue Consumers

client.queues.consumers.list(stringqueueId, ConsumerListParams { account_id } params, RequestOptionsoptions?): SinglePage<Consumer>

GET/accounts/{account_id}/queues/{queue_id}/consumers

Get Queue Consumer

client.queues.consumers.get(stringqueueId, stringconsumerId, ConsumerGetParams { account_id } params, RequestOptionsoptions?): Consumer

GET/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Create a Queue Consumer

client.queues.consumers.create(stringqueueId, ConsumerCreateParamsparams, RequestOptionsoptions?): Consumer

POST/accounts/{account_id}/queues/{queue_id}/consumers

Update Queue Consumer

client.queues.consumers.update(stringqueueId, stringconsumerId, ConsumerUpdateParamsparams, RequestOptionsoptions?): Consumer

PUT/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Delete Queue Consumer

client.queues.consumers.delete(stringqueueId, stringconsumerId, ConsumerDeleteParams { account_id } params, RequestOptionsoptions?): ConsumerDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

ModelsExpand Collapse

Consumer = MqWorkerConsumerResponse { consumer_id, created_on, dead_letter_queue, 4 more } | MqHTTPConsumerResponse { consumer_id, created_on, dead_letter_queue, 3 more }

Response body representing a consumer

One of the following:

MqWorkerConsumerResponse { consumer_id, created_on, dead_letter_queue, 4 more }

consumer_id?: string

A Resource identifier.

maxLength32

created_on?: string

formatdate-time

dead_letter_queue?: string

Name of the dead letter queue, or empty string if not configured

queue_name?: string

script_name?: string

Name of a Worker

settings?: Settings { batch_size, max_concurrency, max_retries, 2 more }

batch_size?: number

The maximum number of messages to include in a batch.

max_concurrency?: number

Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).

max_retries?: number

The maximum number of retries

max_wait_time_ms?: number

The number of milliseconds to wait for a batch to fill up before attempting to deliver it

retry_delay?: number

The number of seconds to delay before making the message available for another attempt.

type?: "worker"

MqHTTPConsumerResponse { consumer_id, created_on, dead_letter_queue, 3 more }

consumer_id?: string

A Resource identifier.

maxLength32

created_on?: string

formatdate-time

dead_letter_queue?: string

Name of the dead letter queue, or empty string if not configured

queue_name?: string

settings?: Settings { batch_size, max_retries, retry_delay, visibility_timeout_ms }

batch_size?: number

The maximum number of messages to include in a batch.

max_retries?: number

The maximum number of retries

retry_delay?: number

The number of seconds to delay before making the message available for another attempt.

visibility_timeout_ms?: number

The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.

type?: "http_pull"

ConsumerDeleteResponse { errors, messages, success }

errors?: Array<ResponseInfo { code, message, documentation_url, source } >

minLength1

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages?: Array<string>

success?: true

Indicates if the API call was successful or not.