Generate frame miniatures

POST

/wp-json/wp2/media-converter/v1/attachments/{id}/frame-miniatures

curl --request POST \
  --url https://example.com/wp-json/wp2/media-converter/v1/attachments/1/frame-miniatures \
  --header 'X-WP-Nonce: <X-WP-Nonce>'

Generates seekbar frame miniatures from the source video. Request body is optional.

Authorizations

• cookie
• applicationPassword

Parameters

Path Parameters

id

required

integer

Numeric entity id.

Responses

200

Media typeapplication/json

object

attachment_id

Media library attachment ID.

integer

markup_vtt

Field “markup_vtt” as returned or accepted by PHP.

string

nullable

base_image_url

Field “base_image_url” as returned or accepted by PHP.

string

nullable

folder

Sprite folder on disk; null after delete.

string

nullable

miniatures

Miniature file list; empty after delete.

Array<string>

message

Deletion/status message; null when unused.

string

nullable

Example^generated

{
  "attachment_id": 1,
  "markup_vtt": "example",
  "base_image_url": "example",
  "folder": "example",
  "miniatures": [
    "example"
  ],
  "message": "example"
}

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": {}
}