Loading…
Claim anonymous uploads, list files, organize folders, and delete files safely.
Anonymous uploads work without an account but return one-time ownership credentials. Save them if the file may need to be claimed or deleted later.
Save fileId and claimToken from the upload response. After registering or supplying an API key, claim the file to attach it to that identity.
Endpoint
https://api.beecargo.net/files/claimAuthentication
Required. Use Bearer bc_* from POST /agent/register, or a dashboard API key with write access.
Request examples
curl -X POST https://api.beecargo.net/files/claim \
-H "Authorization: Bearer YOUR_BC_KEY" \
-H "Content-Type: application/json" \
-d '{"fileId":"abc12xyz","claimToken":"YOUR_CLAIM_TOKEN"}'Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | String | Yes | Short file id from upload (data.id), not a UUID |
claimToken | String | Yes | claimToken from the anonymous upload response |
Usage notes
GET /files/list and uses signed-in retention limits.beecargo_claim_file after beecargo_register_agentclaimTokenTool
Authentication
Needs a bc_* API key (from beecargo_register_agent or x-beecargo-api-key).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | String | Yes | Short file id from upload (data.id), not a UUID |
claimToken | String | Yes | claimToken from the anonymous upload response |
Usage notes
claimToken with fileId. Claim attaches the file to your key so it shows in beecargo_list_files and uses signed-in retention limits.Authenticated identities can list files, include sibling folders, create folders, and filter a library by folder.
Endpoint
Authentication
Required. Send Authorization: Bearer YOUR_API_KEY.
Request examples
# List all files (first page, 50 per page)
curl https://api.beecargo.net/files/list \
-H "Authorization: Bearer YOUR_API_KEY"
# With pagination
curl "https://api.beecargo.net/files/list?page=2&limit=25" \
-H "Authorization: Bearer YOUR_API_KEY"
# Filter by folder
curl "https://api.beecargo.net/files/list?folderId=550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
# List files in root folder only (no folder)
curl "https://api.beecargo.net/files/list?folderId=null" \
-H "Authorization: Bearer YOUR_API_KEY"
# List folder contents (files + subfolders)
curl "https://api.beecargo.net/files/list?folderId=550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"Owned files use an API key. Anonymous files use the deletionToken returned once by upload. Do not confuse it with the claimToken.
Endpoint
Authentication
Required. Send Authorization: Bearer YOUR_API_KEY. You can only delete files you own.
Anonymous files: delete with the token from upload: ?fileId=FILE_ID&token=DELETION_TOKEN
Request examples
# Delete a file with API key
curl -X DELETE "https://api.beecargo.net/files/delete?fileId=550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
# Delete an anonymous file with deletion token (no API key needed)
curl -X DELETE "https://api.beecargo.net/files/delete?fileId=550e8400-e29b-41d4-a716-446655440000&token=YOUR_DELETION_TOKEN"POST https://api.beecargo.net/files/claim with Bearer bc_*Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | Integer | 1 | Page number |
limit | Integer | 50 | Files per page (max 200) |
folderId | String | - | Filter by folder. Use "null" for root only. |
includeFolders | Boolean | true | When true, the response includes a folders array for that folder (or root). Set to "false" for files only. |
Usage notes
data holds files. folders is included when you list a folder and includeFolders is true.parentId (folder UUID or "null" for root), page, limit, search. Response: { success, data: [ folders ], pagination }. Each folder includes id, name, parent_id, file_count, and total_size when not searching.Tool
Authentication
API key required (BEECARGO_API_KEY, x-beecargo-api-key, or self-register first).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | Number | No | Page number (default 1) |
limit | Number | No | Page size, 1–200 (default 50) |
folderId | String | No | Optional folder UUID filter |
includeFolders | Boolean | No | Include sibling folders in the response (default true) |
Usage notes
Tool
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | String | Yes | Folder name, maximum 200 characters |
parentId | UUID | null | No | Parent folder; omit or use null for root |
Usage notes
folderId or parentId.Tool
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
parentId | UUID | No | Only children of this folder |
page | Integer | No | Page number, default 1 |
limit | Integer | No | Page size, maximum 200 |
search | String | No | Folder name search |
Usage notes
beecargo_list_files with includeFolders: true for a combined view.Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | String | Yes | File id from upload (data.id), not a UUID |
token | String | No* | Deletion token for anonymous files (instead of an API key) |
Usage notes
token param is only needed when deleting anonymous files without an API key.Tool
Authentication
API key for owned files, or deletionToken for anonymous uploads.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
fileId | String | Yes | File id from the upload response |
deletionToken | String | No | Required for anonymous deletes when no API key owns the file |
Usage notes
deletionToken returned at upload time.https://api.beecargo.net/files/listhttps://api.beecargo.net/files/delete?fileId=FILE_IDbeecargo_claim_filebeecargo_list_filesbeecargo_create_folderbeecargo_list_foldersbeecargo_delete_file