Upload payload files

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/payload-files

Upload one or more files to temporary storage and get their identifiers, then pass them with target paths in the pipeline run request.

Request

REQUIRED SCOPES

EXECUTION_RUN

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

project_namerequiredstring

The human-readable ID of the project

Example: "my-project"

pipeline_idrequiredinteger

The ID of the pipeline

Example: 123

Response

RESPONSE BODY

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

payload_filesPayloadFileView[]

The list of uploaded files

Last modified on Aug 18, 2026

Cancel, Retry or Approve Download payload file

Request example

CURL
curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/payload-files" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

STATUS
200 OK