POST

/api/v1/documents

http://workdocs.{region}.amazonaws.com/api/v1/documents

Creates a new document object and version object. The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call <a>UpdateDocumentVersion</a>. To cancel the document upload, call <a>AbortDocumentVersionUpload</a>.

Access Token Required: API Key

Body Params

Idstring

The ID of the document.

Namestring

The name of the document.

ContentTypestring

The content type of the document.

ParentFolderIdstring

The ID of the parent folder.

DocumentSizeInBytesinteger

The size of the document, in bytes.

ContentCreatedTimestampstring

The timestamp when the content of the document was originally created.

ContentModifiedTimestampstring

The timestamp when the content of the document was modified.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/documents' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}