Sign in
Content

Get upload result

Changed on

Retrieves the result of an upload operation by identifier.

Returns the root CID for completed uploads, or the current processing status for pending uploads. Accepts either a TUS upload ID or a numeric request ID as the identifier.

See also: POST /upload (upload file), GET /pins/{id} (get pin details)

get/api/upload/result/{identifier}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/upload/result/{identifier}
  • Auth: none declared

Path parameters

identifierstring required

TUS upload ID or numeric request ID. Example: abc123-def456 or 42

Response

Upload result

cidstring
errorstring
status'pending' | 'processing' | 'completed' | 'failed' | 'duplicate' required

Changes

  • 06e0fa4f446eRevision changes
    • info

      added the non-success response with the status

  • b97dd0465ab3Revision changes
    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • warning

      added the new completed enum value to the response property for the response status

    • warning

      added the new duplicate enum value to the response property for the response status

    • warning

      added the new failed enum value to the response property for the response status

    • warning

      added the new pending enum value to the response property for the response status

    • warning

      added the new processing enum value to the response property for the response 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

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status