PRprocess
Files

Create a file

Changed on

Adds a document to a folder in your Library, ready for people with access to use. First call createFileUpload and upload your document to the returned URL, then pass the fileUploadId here. Each upload ID can be used once.

post/files

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/files
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

fileUploadIdstring required

Single-use handle returned by createFileUpload after uploading the document bytes.

namestring required

Display name.

descriptionstring

Optional free-form description of the file.

folderIdstring required

The ID of the Folder.

shareLevel'None' | 'View'

Controls who can view this file. None — only organization members can view this file. View — anyone with the link can view this file.

referenceIdstring

Version prefix used when version control is enabled on this file. Combined with the version number to form the full version identifier.

Response

Example response

{
  "data": {
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes