Sign in
Uploads

Authorize an out-of-band image upload

Changed on

Authorizes an OUT-OF-BAND upload of a LOCAL image file, made from outside this API client (e.g. with curl), so its bytes never pass through the caller's prompt. Returns a self-contained descriptor: an uploadUrl, a short-lived single-use ticket, and the header/field to use.

Upload the file with a plain HTTPS POST to uploadUrl: send the ticket in the X-Upload-Ticket header and the file as multipart field file. That call returns a staging ref, which you then attach with image: { ref } on an event write.

An image already reachable at a public http(s) URL is attached directly with image: { url } on the write, with no ticket.

The ticket expires after 15 minutes (expiresAt) and is consumed by a successful upload.

post/agendas/{agendaUid}/uploads/ticket

Request

  • Base URL: https://api.openagenda.com/v3
  • URL: https://api.openagenda.com/v3/agendas/{agendaUid}/uploads/ticket
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://openagenda.com/api/auth/oauth2/authorize, token URL https://openagenda.com/api/auth/oauth2/token, scopes: media:write)

Path parameters

agendaUidinteger required

Numeric uid of the agenda.

Response

An out-of-band upload descriptor.

uploadUrlstring uri required

Absolute URL to POST the file to (out of band).

methodstring required

The HTTP method to use for the upload (POST).

headerstring required

The header carrying the ticket (X-Upload-Ticket).

fieldstring required

The multipart form field for the file (file).

ticketstring required

The single-use capability ticket. Upload-only, bound to this agenda, one file, short-lived; carries no account credential.

maxBytesinteger required

Maximum accepted file size, in bytes.

expiresAtstring date-time required

When the ticket expires (ISO 8601).

Changes

  • 504611f6f282Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • 550dac9bcc88Revision changes
    • info

      the security scope events:write was added to the endpoint's security scheme oauth2

    • info

      the security scope media:write was removed from the endpoint's security scheme oauth2

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the bad_request enum value from the / response property for the response status

    • info

      removed the bad_request enum value from the / response property for the response status

    • info

      removed the bad_request enum value from the / response property for the response status

    • info

      removed the bad_request enum value from the / response property for the response status

    • info

      removed the forbidden enum value from the / response property for the response status

    • info

      removed the forbidden enum value from the / response property for the response status

    • info

      removed the forbidden enum value from the / response property for the response status

    • info

      removed the forbidden enum value from the / response property for the response status

    • info

      removed the insufficient_scope enum value from the / response property for the response status

    • info

      removed the insufficient_scope enum value from the / response property for the response status

    • info

      removed the insufficient_scope enum value from the / response property for the response status

    • info

      removed the insufficient_scope enum value from the / response property for the response status

    • info

      removed the not_found enum value from the / response property for the response status

    • info

      removed the not_found enum value from the / response property for the response status

    • info

      removed the not_found enum value from the / response property for the response status

    • info

      removed the not_found enum value from the / response property for the response status

    • info

      removed the read_only_credential enum value from the / response property for the response status

    • info

      removed the read_only_credential enum value from the / response property for the response status

    • info

      removed the read_only_credential enum value from the / response property for the response status

    • info

      removed the read_only_credential enum value from the / response property for the response status

    • info

      removed the service_unavailable enum value from the / response property for the response status

    • info

      removed the service_unavailable enum value from the / response property for the response status

    • info

      removed the service_unavailable enum value from the / response property for the response status

    • info

      removed the service_unavailable enum value from the / response property for the response status

    • info

      removed the unauthorized enum value from the / response property for the response status

    • info

      removed the unauthorized enum value from the / response property for the response status

    • info

      removed the unauthorized enum value from the / response property for the response status

    • info

      removed the unauthorized enum value from the / response property for the response status