# Download an object's bytes

`GET /projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/downloadbeta`

Streams the raw bytes of the named object from the bucket on the specified branch, including objects inherited from ancestor branches. Served by the user's session (no customer S3 credentials required).

The body is returned as `application/octet-stream` so a browser treats it as a download; the `Content-Length` and `ETag` response headers echo the stored object metadata.

BINARY-STREAM EXCEPTION TO THE BUILD-GENERATED-TYPES RULE (#7029): the successful 200 body is the raw object stream, proxied verbatim from the platform object storage admin endpoint. It is modeled as an `application/octet-stream` binary body (not a JSON response schema) and is streamed without buffering the whole object in memory. Error responses still use the generated `GeneralError` shape.

**Note**: This endpoint is currently in Beta.

[Markdown for AI context](/guides/apis-sdks-reference-api-buckets-get-project-branch-bucket-object)

```bash title="REST API - curl"
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/buckets/$BUCKET_NAME/objects/$OBJECT_KEY/download" \
  -H "Authorization: Bearer $NEON_API_KEY"
```

Every field below is optional. An empty body works too.

Also available in

::::tabs
:::tab{title="CLI"}
```bash
neon buckets object get <branch_id>
```
:::

:::tab{title="SDK"}
:::
::::

## Parameters

Project ID

`project_id`

string

The Neon project ID

Branch ID

`branch_id`

string

The Neon branch ID

Bucket name

`bucket_name`

string

The bucket name

Object key

`object_key`

string

The object key. Keys may contain `/`; the `/` characters of nested keys must be percent-encoded (`%2F`) in the path segment.

## Response

200

The object's raw bytes, streamed verbatim. `Content-Length` and `ETag` headers are set from the stored object metadata; `X-Content-Type-Options` and `Content-Disposition` harden the browser against the caller-controlled bytes.

No example available.

## Errors

404

Object not found

default

General error

This endpoint can return the standard Neon API error response.

Response fields

- `message` Required. Human-readable error message.
- `code` Required. Machine-readable error code.
- `request_id` Optional. Request identifier for debugging. You can provide one with the `X-Request-ID` header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (`GET`, `HEAD`, `OPTIONS`) are generally safe to retry after a network error or timeout. Non-idempotent methods (`POST`, `PATCH`, `DELETE`, `PUT`) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with `423 Locked` or `503 Service Unavailable` are safe to retry. `423 Locked` means the resource is temporarily locked, usually because another operation is in progress.

## Related pages

- [Create a bucket on the branch](./apis-sdks-reference-api-buckets-create-project-branch-bucket.md)
- [Delete a bucket on the branch](./apis-sdks-reference-api-buckets-delete-project-branch-bucket.md)
- [Delete an object in a bucket](./apis-sdks-reference-api-buckets-delete-project-branch-bucket-object.md)
- [Delete every object under a key prefix (folder) in a bucket](./apis-sdks-reference-api-buckets-delete-project-branch-bucket-objects-by-prefix.md)
- [List buckets on the branch](./apis-sdks-reference-api-buckets-list-project-branch-buckets.md)
- [List objects in a bucket](./apis-sdks-reference-api-buckets-list-project-branch-bucket-objects.md)
- [Presign an upload or download for an object in a bucket](./apis-sdks-reference-api-buckets-presign-project-branch-bucket-object.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.