Misc · Drive
Get file
Gets a drive file by organization ID and file ID. Returns the file with links to open it and its preview image. Actor details may be masked depending on the caller’s permissions.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have access to the organization.
- A caller with
drive.readand more than assigned-only drive access can get the file without a shared-folder check. - Otherwise, the file must be in a folder shared with the caller.
- Without
user.read, details of a non-current, non-contact actor are masked. The current actor is exempt from this check. - Without
apiKey.read, API actor details are masked, even for the current actor.
Request
Path parameters
-
organizationIdidrequired -
fileIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/files/YOUR_FILE_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/files/YOUR_FILE_ID", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/files/YOUR_FILE_ID', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
_idid -
folderidnullable -
namestring1–128 characters
-
kindstringimagevideoaudiopdfwordexcelpowerpointtextarchiveother -
fileobject4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
thumbnailobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
widthintegernullable -
heightintegernullable -
durationSecondsnumbernullableat least 0
-
waveformnumber[]nullableat most 96 items · each 0–1
-
createdAtstring · date-timenullable -
createdByobjectnullable -
updatedAtstring · date-timenullable -
updatedByobjectnullable
More about the fields
createdBy.image:createdBy.imageis null when a user actor is masked and the field must retain a user actor.updatedBy.image:updatedBy.imageis null when a user actor is masked and the field must retain a user actor.
Response200
{
"_id": "000000000000000000000001",
"folder": "000000000000000000000001",
"name": "string",
"kind": "image",
"file": {
"resource": "string"
},
"thumbnail": {
"resource": "string"
},
"width": 1,
"height": 1,
"durationSeconds": 0,
"waveform": [
0
]
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The file was not found | If the file is not found in the organization, the endpoint returns HTTP 404 with routes.misc.drive.noFile. |
| 404 | The file was not found | If the caller cannot bypass the shared-folder check and the file has no folder or its folder is not shared, the endpoint returns HTTP 404 with routes.misc.drive.noFile. |
Errors nearly every request can meet are listed under Errors.