Download a value

A value is raw binary data stored separately from object state. Uploading a value returns an opaque valueRef that state can reference, so large or binary payloads stay out of the inline state body.

Download a stored blob by fully qualified object name and valueRef. The response body contains raw bytes, not JSON.

Use the response Content-Type to interpret the data and Content-Disposition for the suggested filename. Both headers are derived from metadata supplied through Upload a value.

A 404 means the object and valueRef pair does not identify a stored blob. Copy both values exactly from the state response or locate the reference with List stored values.

GET
{{host}}/v1/value?object={{object}}&valueRef={{valueRef}}
VERB:GET
BASE URL:{{host}}/v1/value
QUERY STRING:?object={{object}}&valueRef={{valueRef}}

Query parameters#

  • objectstring
    Required

    Unique name of the object in the URL.

    format:
    abc:0-9@owner
  • valueRefstring
    Required

    Identifier returned when the blob was stored (POST).

    example: Mqn0WDHP8cuLYkMIjxAqmSdz8vRkTDDhB5Ie6Sn3

Headers#

Send these headers with the request. Names are case-insensitive per HTTP rules.
  • x-api-keyRequired

    Your BigState API key.

    {{apiKey}}

Need a session token? See Token sign in.

Response parameters#

  • 200Response body · object

    Success. Response body is raw bytes (not JSON). `Content-Type` and `Content-Disposition` are HTTP response headers — they come from metadata stored at upload (`filemimetype` and `filename` on POST), so the download name matches that upload, not an arbitrary client label.

    • Content-Typestring

      Response header. MIME type recorded when the blob was uploaded (`filemimetype` on POST).

      example: image/png
    • Content-Dispositionstring

      Response header. Suggested download name (`attachment`; `filename` / `filename*`), from metadata stored at upload (`filename` on POST).

      example: attachment; filename="photo.png"
    • bodyany

      Raw file bytes in the HTTP response body.

  • 401

    Unauthorized.

  • 403

    Access denied. The caller does not have sufficient rights to perform this operation.

  • 404

    No blob exists for this object and valueRef.

  • 400Response body · object

    Bad request.

    {

      "error": 6,

      "desc": "Object must be formatted as object"

    }
    • errornumber

      Numeric error code. Use the response `desc` field for the human-readable explanation.

    • descstring

      Human-readable description of the error.

Examples#

Download a value

GET returns raw bytes in the response body. Read `Content-Type` and `Content-Disposition` from the HTTP response headers.

curl 'https://api.bigstate.dev/v1/value?object=Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6%3Aposition%3Avalueref%40Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6&valueRef=Mqn0WDHP8cuLYkMIjxAqmSdz8vRkTDDhB5Ie6Sn3' \

  --header 'x-api-key: YOUR_API_KEY'
UploadList

© 2024 BigState