SKskyvern-ai
Files

Upload a file

Changed on

Upload a file to Skyvern storage so runs can reference it as an input. Returns the file id, its storage URI, a presigned download URL, and the expiry implied by the requested retention period.

post/v1/upload_file

Request

  • Base URL
    https://api.skyvern.com
  • URL
    https://api.skyvern.com/v1/upload_file
  • Auth
    API key in header x-api-key

Request body multipart/form-data

retention_daysinteger nullable

Number of days to keep the file before it is deleted automatically. Omit to keep the file until the organization's data retention policy removes it.

filestring binary required

Response

Successful Response

s3_uristring required

S3 URI where the file was uploaded

presigned_urlstring required

Presigned URL to access the uploaded file

file_idstring nullable

Identifier for this upload. Pass it to DELETE /v1/files/{file_id} to delete the file.

expires_atstring date-time nullable

When the file will be deleted, if a retention_days was supplied. Null means the file has no expiry of its own and follows the organization's data retention policy.

Changes

  • 539f04093540Revision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

  • 830020b643cdRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status