Create Account File (from URL)

POST

https://api.coperniq.io/v1/accounts/:account_id/files

POST

/v1/accounts/:account_id/files

1 const url = 'https://api.coperniq.io/v1/accounts/1/files';
2 const options = {
3   method: 'POST',
4   headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{"url":"https://example.com/documents/signed-agreement.pdf","name":"signed-agreement.pdf"}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "id": 4,
3   "name": "signed-agreement.pdf",
4   "downloadUrl": "https://cdn.coperniq.io/files/signed-agreement.pdf",
5   "metaData": {
6     "acl": "private",
7     "size": 153600,
8     "userId": 42,
9     "mimeType": "application/pdf",
10     "extention": "pdf",
11     "originalName": "signed-agreement.pdf",
12     "generatedName": "def456ghi789.pdf"
13   }
14 }

Upload a file to an account by providing its URL

Note: The /clients path is an alias for /accounts and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

account_idintegerRequired

Account identifier

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

URL of the file to upload

namestringOptional

Name of the file

isArchivedbooleanOptionalDefaults to false

Whether the file is archived

Response

Successful response

idinteger

File identifier

namestring

File name

downloadUrlstring

URL to download the file

typestring

File type

updatedAtstringformat: "date-time"

Last update timestamp

createdAtstringformat: "date-time"

Creation timestamp

metaDataobject

sourcestring

File source (e.g., INTERNAL)

createdByUserobject

isArchivedbooleanOptional

Whether the file is archived

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error