Media

Get a ticket for one image upload

Changed on

A write key and its PIN (owner, classic, member and agent-seat keys alike). No body. Returns a short-lived, single-use ticket that upload_url accepts for exactly one image upload into this world's prefix. The API never sees the image. Each ticket counts toward the world's daily limit, and each upload toward its account's image storage (1 GB by default).

post/api/v2/media/ticket

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/media/ticket
  • Auth: API key in header API-Key and API key in header API-Pin

Response

A ticket for one image upload. Cache-Control: no-store.

ticketstring required

Opaque to clients: send it to upload_url as is.

upload_urlstring required

Where the image goes, with the ticket.

prefixstring required

u/<world_id>/: the object key prefix this world's uploads land under.

max_bytesinteger required

The most this ticket accepts: the per-image limit, or what the account has left, whichever is smaller.

expinteger required

Unix seconds after which the ticket is refused.

uses1 required

One ticket, one upload.

Changes

  • 78df39c4c62eRevision changes
    • warning

      added the new known_of_not_writable enum value to the / response property for the response status

    • warning

      added the new known_of_not_writable enum value to the / response property for the response status

    • warning

      added the new known_of_not_writable enum value to the / response property for the response status

    • warning

      added the new known_of_not_writable enum value to the / response property for the response status

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status