Skip to content

Get queue entry

GET
/wp-json/wp2/media-converter/v1/queue/{key}
curl --request GET \
--url https://example.com/wp-json/wp2/media-converter/v1/queue/example \
--header 'X-WP-Nonce: <X-WP-Nonce>'

One queue entry by key: status, formats, errors.

key
required
string

Password-reset key from email, or a queue key.

Media typeapplication/json
object
queue_key

Field “queue_key” as returned or accepted by PHP.

string
attachment_id

Media library attachment ID.

integer
formats

Encode format catalog or selection.

object
status

Status (build, post, or license — depending on the operation).

string
poll_url

Field “poll_url” as returned or accepted by PHP.

string format: uri
Examplegenerated
{
"queue_key": "example",
"attachment_id": 1,
"formats": {},
"status": "example",
"poll_url": "https://example.com"
}

Not authenticated. WordPress REST: rest_not_logged_in / rest_forbidden. Use cookie + X-WP-Nonce or Application Password.

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}

Insufficient capability or invalid REST nonce. WordPress REST: rest_forbidden / rest_cookie_invalid_nonce.

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}