Skip to main content
POST
/
api
/
v1
/
remote-files
CreateRemoteFile
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/remote-files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "<string>",
  "entityId": "<string>",
  "entityType": "ENTITY_TYPE_UNSPECIFIED",
  "fileMimeType": "<string>",
  "fileContentEncoding": "<string>",
  "fileSize": "<string>",
  "description": "<string>",
  "organizationId": "<string>",
  "videoMetadata": {
    "height": 123,
    "width": 123,
    "durationSeconds": 123,
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "imageMetadata": {
    "height": 123,
    "width": 123
  },
  "audioMetadata": {
    "durationSeconds": 123,
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "customUuid": "<string>"
}
'
{
  "remoteFile": {
    "remoteFileId": "<string>",
    "organizationId": "<string>",
    "entityId": "<string>",
    "entityType": "ENTITY_TYPE_UNSPECIFIED",
    "fileName": "<string>",
    "fileMimeType": "<string>",
    "fileContentEncoding": "<string>",
    "storageKey": "<string>",
    "fileSize": "<string>",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "videoMetadata": {
      "height": 123,
      "width": 123,
      "durationSeconds": 123,
      "timestamp": "2023-11-07T05:31:56Z"
    },
    "imageMetadata": {
      "height": 123,
      "width": 123
    },
    "audioMetadata": {
      "durationSeconds": 123,
      "timestamp": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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

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

​
fileName
string
required
​
entityId
string
required
​
entityType
enum<string>
default:ENTITY_TYPE_UNSPECIFIED
required
Available options:
ENTITY_TYPE_UNSPECIFIED,
ENTITY_TYPE_RUN,
ENTITY_TYPE_ANNOTATION,
ENTITY_TYPE_ASSET,
ENTITY_TYPE_ANNOTATION_LOG,
ENTITY_TYPE_TEST_REPORT
​
fileMimeType
string
required
​
fileContentEncoding
string
required
​
fileSize
string<uint64>
required
​
description
string
​
organizationId
string

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

​
videoMetadata
object
​
imageMetadata
object
​
audioMetadata
object
​
customUuid
string

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

Response

A successful response.

The response for a call to RemoteFileService_CreateRemoteFile.

​
remoteFile
object
required