Skyvern: Upload a file

← Files operations · Get started

Operation skyvern.upload_file_v1_upload_file_post

Provider route: POST /v1/upload_file. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["files"]["uploadFile"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.files.uploadFile(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.files.upload_file(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent
body.file	object	Required within parent	Additional keys: not allowed
body.file.filename	string	Required within parent	Minimum length: 1
body.file.content_type	string	Required within parent	Minimum length: 1
body.file.content_base64	string	Required within parent
body.retention_days	JSON	Optional	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.
body.retention_days (anyOf 1)	integer	Alternative
body.retention_days (anyOf 2)	null	Alternative

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Upload a file — response body

Referenced models: Upload a file — response body

Schemas

Upload a file — response body

Field	Type	Presence	Description and constraints
$	object	Root
expires_at	JSON	Optional	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.
expires_at (anyOf 1)	string	Alternative	Format: date-time
expires_at (anyOf 2)	null	Alternative
file_id	JSON	Optional	Identifier for this upload. Pass it to DELETE /v1/files/{file_id} to delete the file.
file_id (anyOf 1)	string	Alternative
file_id (anyOf 2)	null	Alternative
presigned_url	string	Required within parent	Presigned URL to access the uploaded file
s3_uri	string	Required within parent	S3 URI where the file was uploaded

Policy, approvals and errors

SDK function policy ID: skyvern.upload_file_v1_upload_file_post. Catalog operation: upload_file_v1_upload_file_post. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source