Create a file

post

https://api.safetyculture.io/documents/v1

Creates a new file in Documents and returns a URL to upload the file.

Body Params

path

array of strings

An array of folder names that defines the path where the file will be stored. The path is relative to the parent_id if it is provided. If not, it starts from the root folder. The API will automatically create any folders in the path that don’t exist. Each folder name must be 1-255 characters and exclude invalid characters.

path

name

string

The name of the file. Must be between 1-255 characters and exclude invalid characters.

file_type

string

enum

The type of the file to be created. Please note that videos are currently not supported.

Allowed:

file_size

int64

The size of the file in bytes. Must not exceed 50MB. This field is required if file_type is provided.

parent_id

string

The ID of the folder where the file should be stored. Any folders defined in the path will be created inside the parent folder. If you don’t provide a parent_id, the file will be stored in the root folder. To get the parent_id, open the folder in the SafetyCulture web app and copy the last part of the URL. For example, in this link https://app.safetyculture.com/documents/9dd76834-65ef-41d3-815c-964df32450e4, the parent ID is 9dd76834-65ef-41d3-815c-964df32450e4.

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.