Get file info

Look up file details by short codes.

Same flow in MCP: beecargo_file_info

Endpoint

GEThttps://api.beecargo.net/files/info?file_code=shortCode1,shortCode2

Authentication

Optional. You can send an API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Request examples

Pass one or more short codes, separated by commas.

# Get info for a single file

curl "https://api.beecargo.net/files/info?file_code=abc123"

# Get info for multiple files (comma-separated)

curl "https://api.beecargo.net/files/info?file_code=abc123,xyz789,def456"

# With API key authentication

curl "https://api.beecargo.net/files/info?file_code=abc123&key=YOUR_API_KEY"

# Or with Authorization header

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.beecargo.net/files/info?file_code=abc123,xyz789"

Parameters

Parameter	Type	Required	Description
`file_code`	String	Yes	Comma-separated short codes (e.g. `"abc123,xyz789"`)

Response

Returns an array of file objects. Each has a status of 200 (found) or 404 (not found).

{
  "msg": "OK",
  "server_time": "2024-01-01 12:00:00",
  "status": 200,
  "result": [
    {
      "status": 200,
      "filecode": "abc123",
      "name": "document.pdf",
      "size": "1048576",
      "uploaded": "2024-01-01 10:00:00",
      "download": "42",
      "status_field": "active"
    },
    {
      "status": 404,
      "filecode": "xyz789"
    },
    {
      "status": 200,
      "filecode": "def456",
      "name": "image.jpg",
      "size": "524288",
      "uploaded": "2024-01-01 11:00:00",
      "download": "15",
      "status_field": "active"
    }
  ]
}

Response fields

Field	Type	Description
`msg`	String	Response message (`"OK"` on success)
`server_time`	String	Server time as `"YYYY-MM-DD HH:MM:SS"`
`status`	Number	HTTP status (200 on success)
`result`	Array	List of file info objects
`result[].status`	Number	200 if found, 404 if not
`result[].filecode`	String	Short code (`short_id`) of the file
`result[].name`	String	File name (when status is 200)
`result[].size`	String	Size in bytes as a string (when status is 200)
`result[].uploaded`	String	Upload time as `"YYYY-MM-DD HH:MM:SS"` (when status is 200)
`result[].download`	String	Download count as a string (when status is 200)
`result[].status_field`	String	File state: `"active"`, `"deleted"`, `"dmca_removed"`, or `"expired"` (when status is 200)
`result[].unlockRequired`	Boolean	True when download needs an unlock code or delivery link first (when status is 200)

Error response

{
  "msg": "Bad Request",
  "status": 400,
  "error": "file_code parameter is required (comma-separated shortCodes)"
}

Usage notes

You can look up several files at once with comma-separated short codes
Each item in result has its own status (200 or 404)
Only files with status "active" can be downloaded
This response does not include scanStatus. Poll GET /files/share/{shortId} before machine download.
When unlockRequired is true, GET /files/download/{fileId} needs unlockCode or unlockToken (or call POST /downloads/unlock with handoffToken from /h/{token})
Auth is optional; a key can help with rate limits

Try it

Request examples

Pass one or more short codes, separated by commas.

# Get info for a single file

curl "https://api.beecargo.net/files/info?file_code=abc123"

# Get info for multiple files (comma-separated)

curl "https://api.beecargo.net/files/info?file_code=abc123,xyz789,def456"

# With API key authentication

curl "https://api.beecargo.net/files/info?file_code=abc123&key=YOUR_API_KEY"

# Or with Authorization header

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.beecargo.net/files/info?file_code=abc123,xyz789"

Parameter

Type

Required

Description

file_code

String

Yes

Comma-separated short codes (e.g. "abc123,xyz789")

Response

Returns an array of file objects. Each has a status of 200 (found) or 404 (not found).

{
  "msg": "OK",
  "server_time": "2024-01-01 12:00:00",
  "status": 200,
  "result": [
    {
      "status": 200,
      "filecode": "abc123",
      "name": "document.pdf",
      "size": "1048576",
      "uploaded": "2024-01-01 10:00:00",
      "download": "42",
      "status_field": "active"
    },
    {
      "status": 404,
      "filecode": "xyz789"
    },
    {
      "status": 200,
      "filecode": "def456",
      "name": "image.jpg",
      "size": "524288",
      "uploaded": "2024-01-01 11:00:00",
      "download": "15",
      "status_field": "active"
    }
  ]
}

Response fields

Field	Type	Description
`msg`	String	Response message (`"OK"` on success)
`server_time`	String	Server time as `"YYYY-MM-DD HH:MM:SS"`
`status`	Number	HTTP status (200 on success)
`result`	Array	List of file info objects
`result[].status`	Number	200 if found, 404 if not
`result[].filecode`	String	Short code (`short_id`) of the file
`result[].name`	String	File name (when status is 200)
`result[].size`	String	Size in bytes as a string (when status is 200)
`result[].uploaded`	String	Upload time as `"YYYY-MM-DD HH:MM:SS"` (when status is 200)
`result[].download`	String	Download count as a string (when status is 200)
`result[].status_field`	String	File state: `"active"`, `"deleted"`, `"dmca_removed"`, or `"expired"` (when status is 200)
`result[].unlockRequired`	Boolean	True when download needs an unlock code or delivery link first (when status is 200)

Usage notes

You can look up several files at once with comma-separated short codes
Each item in result has its own status (200 or 404)
Only files with status "active" can be downloaded
This response does not include scanStatus. Poll GET /files/share/{shortId} before machine download.
When unlockRequired is true, GET /files/download/{fileId} needs unlockCode or unlockToken (or call POST /downloads/unlock with handoffToken from /h/{token})
Auth is optional; a key can help with rate limits