API DocsRESTRemote file service

CreateRemoteFile

Create a remote file. Note that this does not perform the actual file upload. See UploadRemoteFile.

POST
/api/v1/remote-files

Request Body

application/jsonRequired

The request for a call to RemoteFileService_CreateRemoteFile to create a remote file.

fileName
Required
string

entityId
Required
string

entityType
Required
string

Default: "ENTITY_TYPE_UNSPECIFIED"Value in: "ENTITY_TYPE_UNSPECIFIED" | "ENTITY_TYPE_RUN" | "ENTITY_TYPE_ANNOTATION" | "ENTITY_TYPE_ASSET" | "ENTITY_TYPE_ANNOTATION_LOG"

fileMimeType
Required
string

fileContentEncoding
Required
string

fileSize
Required
string

Format: "uint64"

descriptionstring

organizationIdstring

This field is only required if your user belongs to multiple organizations.

videoMetadataobject

imageMetadataobject

audioMetadataobject

customUuidstring

A custom UUID used to generate the object key. Recommended to be left unset.

curl -X POST "<API_URL>/api/v1/remote-files" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "string",
    "entityId": "string",
    "entityType": "ENTITY_TYPE_UNSPECIFIED",
    "fileMimeType": "string",
    "fileContentEncoding": "string",
    "fileSize": "string",
    "description": "string",
    "organizationId": "string",
    "videoMetadata": {
      "height": 0,
      "width": 0,
      "durationSeconds": 0.1,
      "timestamp": "2019-08-24T14:15:22Z"
    },
    "imageMetadata": {
      "height": 0,
      "width": 0
    },
    "audioMetadata": {
      "durationSeconds": 0.1,
      "timestamp": "2019-08-24T14:15:22Z"
    },
    "customUuid": "string"
  }'

A successful response.

{
  "remoteFile": {
    "remoteFileId": "string",
    "organizationId": "string",
    "entityId": "string",
    "entityType": "ENTITY_TYPE_UNSPECIFIED",
    "fileName": "string",
    "fileMimeType": "string",
    "fileContentEncoding": "string",
    "storageKey": "string",
    "fileSize": "string",
    "description": "string",
    "videoMetadata": {
      "height": 0,
      "width": 0,
      "durationSeconds": 0.1,
      "timestamp": "2019-08-24T14:15:22Z"
    },
    "imageMetadata": {
      "height": 0,
      "width": 0
    },
    "audioMetadata": {
      "durationSeconds": 0.1,
      "timestamp": "2019-08-24T14:15:22Z"
    },
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z"
  }
}

Previous

BatchDeleteRemoteFiles POST

Next

DeleteRemoteFile DELETE