Upload File

URL Expired

The URL for this request expired after 30 days.

UploadFileRequest

UploadFileRequest is the request object for the UploadFile method.

• file
  • object
  • required
  • The file to upload.

UploadFileResponse

UploadFileResponse is the response object for the UploadFile method.

• file
  • object
  • required
  • The uploaded file. This will be the same as the request file, but without the file contents.
  • id
    • string
    • length ≤ 50
    • The identifier of the file
  • filePayload
    • string
    • length between 1 and 3670016
    • Raw binary representation of a file. The size of the binary payload is limited to 3.5 MiB.

See this guide for more information about uploading files.

uploadDetails

• Details about the file upload

Error Codes

• 200 A successful response.
• 400 Returned if required fields are omitted or if provided fields fail validation.
• 401 Returned if a valid Authorization header has not been included with the request.
• 403 Returned when the user does not have permission to access the resource.
• 500 Returned if an unexpected internal server error is encountered.
• default An unexpected error response.

Example Request

curl --request POST \
     --url https://mock-api.carta.com/v1alpha1/files:upload \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Response

{
  "file": {
    "id": "e3b8b6e0-9a9b-4b3a-8b0a-5b2b8a5b2b8a",
    "filePayload": "string",
    "uploadDetails": {
      "name": "my_file.pdf",
      "description": "This is an example file description.",
      "tags": [
        "production",
        "2023",
        "pdf"
      ]
    }
  }
}