Skip to content
campaiDeveloper
campai.com

Misc · Drive

POST/{organizationId}/misc/drive/files

Create file

Adds an uploaded file to an organization’s drive, either in a folder or at the top level, with an optional thumbnail and file details. Returns the new file’s _id.

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 organization access and the drive.insert permission.
  • Callers with assigned-only drive access must create the file inside a folder shared with them; they cannot create it at the top level.

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • namestringrequired

    1–128 characters

  • widthintegerrequirednullable
  • heightintegerrequirednullable
  • durationSecondsnumberrequirednullable

    at least 0

  • waveformnumber[]requirednullable

    at most 96 items · each 0–1

  • folderIdidrequirednullable
  • fileobjectrequired
    2 properties
    • fileNamestring

      at most 128 characters

    • resourcestringrequired
  • thumbnailobjectrequirednullable
    2 properties
    • fileNamestring

      at most 128 characters

    • resourcestringrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/files' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • _idid
Response200
{
  "_id": "000000000000000000000001"
}

What else happens

  • On success, the endpoint inserts a driveFiles record.
  • When the file is placed in a folder, the endpoint updates contentUpdatedAt on that folder and its ancestors.
  • If the storage limit is exceeded, the stored file and thumbnail resources are removed.
  • On success, the endpoint increases cached drive storage usage by the stored file and thumbnail size.

Errors

Other errors

StatusErrorWhen
403You can only work inside folders shared with youIf an assigned-only caller cannot write to the target folder, the endpoint returns 403 with key misc.drive.sharedFoldersOnly.
404The folder was not foundIf the specified folder is not found after the access check, the endpoint returns 404 with key routes.misc.drive.noFolder.

Errors nearly every request can meet are listed under Errors.