Sign in
Files

Upload a file

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

Headers

x-api-keystring nullable

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.

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

Changed in 3 of the 86 revisions of this API.19

  • 830020b643cd3See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 3a3616091b6615See the full diff
    • ▲

      the request property contentMediaType changed from to application/octet-stream

      request-property-content-media-type-changed

    • ○

      header request parameter x-api-key list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the header request parameter x-api-key, the type was generalized from string to no type

      request-parameter-type-generalized

    • ○

      the request property format was generalized from binary to no format

      request-property-type-generalized

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a8899e7707c41See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog