Skip to content

docs: document binary file uploads #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seveibar merged 1 commit into from
Sep 17, 2025
Merged

docs: document binary file uploads #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,34 @@ The returned file will contain either `text_content` or `binary_content_b64`.
Provide either `text_content` for text files or `binary_content_b64` for
binary data. The response will include whichever field was supplied.

#### Add Binary Files

To upload binary assets (for example, images or compiled artifacts) encode the
file contents as Base64 and provide them via the `binary_content_b64` field.

```http
POST /files/upsert
Content-Type: application/json

{
"file_path": "assets/logo.png",
"binary_content_b64": "iVBORw0KGgoAAAANSUhEUgAA..."
}

Response: {
"file": {
"file_id": "42",
"file_path": "assets/logo.png",
"binary_content_b64": "iVBORw0KGgoAAAANSUhEUgAA...",
"created_at": "2024-01-01T00:00:00.000Z"
}
}
```

The server persists the binary payload exactly as provided. When retrieving the
file with `/files/get`, the same `binary_content_b64` string will be returned
and can be decoded back to the original bytes in your client code.

#### Get File

```http
Expand Down