​
POST /v1/file/upload

​
Query parameters

No query parameters accepted.

​
Responses

ParameterTypeDescription
urlstringDirect URL to the final PDF file stored in S3.
outputLinkValidTillstringTimestamp indicating when the output link will expire
errorbooleanIndicates whether an error occurred (false means success)
statusstringStatus code of the request (200, 404, 500, etc.). For more information, see Response Codes.
namestringName of the output file
creditsintegerNumber of credits consumed by the request
remainingCreditsintegerNumber of credits remaining in the account
durationintegerTime taken for the operation in milliseconds

​
Example Response

To see the main response codes, please refer to the Response Codes page.
{
  "url": "https://pdf-temp-files.s3.amazonaws.com/1a4a92ac805c41c28ef75a24e0f35ba5/sample.pdf",
  "error": false,
  "status": 200,
  "name": "sample.pdf",
  "remainingCredits": 98145
}

​
Code Samples

curl --location --request POST 'https://api.pdf.co/v1/file/upload'
--header 'x-api-key: *******************'
--form 'file=@"/path/to/file"'