Upload and/or enqueue encode

POST

/wp-json/wp2/media-converter/v1/encode

curl --request POST \
  --url https://example.com/wp-json/wp2/media-converter/v1/encode \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "attachment_id": 1, "formats": [ "example" ], "options": {}, "parent_id": 1, "blog_id": 1 }'

Enqueues encoding: either an existing attachment_id or a multipart file (plus formats). Returns 202.

Authorizations

• cookie
• applicationPassword

Request Body

object

attachment_id

Media library attachment ID.

integer

formats

Encode format catalog or selection.

Array<string>

options

Rejected in v1 (400 job_options_not_supported). Use PATCH /settings.

object

parent_id

Parent ID when creating a site or term.

integer

blog_id

Network site ID. Optional on a single site.

integer

Example^generated

{
  "attachment_id": 1,
  "formats": [
    "example"
  ],
  "options": {},
  "parent_id": 1,
  "blog_id": 1
}

object

file

Uploaded file (multipart).

string format: binary

formats

Encode format catalog or selection.

string

attachment_id

Media library attachment ID.

integer

Responses

202

Media typeapplication/json

object

attachment_id

Media library attachment ID.

integer

queue_key

Field “queue_key” as returned or accepted by PHP.

string

formats

Encode format catalog or selection.

Array<string>

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

Example^generated

{
  "attachment_id": 1,
  "queue_key": "example",
  "formats": [
    "example"
  ],
  "status": "example",
  "poll_url": "https://example.com"
}

401

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

Example^generated

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

403

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

Example^generated

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