Document, File & System

Upload File from URL

Downloads file from a source url and uploads it as a temporary file. Temporary files are automatically permanently removed after 1 hour.

post/v1/file/upload/url

Request

  • Base URL
    https://api.pdf.co
  • URL
    https://api.pdf.co/v1/file/upload/url
  • Auth
    API key in header x-api-key

Request body

namestring

File name for generated output.

urlstring uri required

URL to the source file url attribute.

httpusernamestring

HTTP auth user name if required to access source URL.

httppasswordstring

HTTP auth password if required to access source URL.

Response

Success.

statusstring

Status of the API response.

messagestring

Descriptive message for the response status.

urlstring uri

URL to the output file.

jobIdstring

Unique identifier for the job.

creditsinteger

Credits used for this operation.

remainingCreditsinteger

Credits remaining after this operation.

durationinteger

Time taken to complete the request, in milliseconds.

Example response

{
  "status": "success",
  "message": "Success",
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf",
  "jobId": "6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA",
  "credits": 2,
  "remainingCredits": 1480582,
  "duration": 33
}

Changes

No recorded changes to this operation across all 14 revisions of this API.