Upload

View as Markdown

POST
/workspaces
/:workspace
/artifacts
/:artifact_id
/versions
/:version_id
/upload

Upload artifact version from ZIP archive

Request

REQUIRED SCOPES

ARTIFACT_WRITE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

artifact_idrequiredstring

The Artifact ID

Example: "x5169jL2"

version_idrequiredstring

The Version ID

Example: "a9f84k2L"

Response

RESPONSE BODY

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idstring

The unique ID of the version (used in API endpoints)

versionstring

The version identifier (e.g., latest, v1.2.0, stable)

sizeinteger

Size of the version content in bytes

draftboolean

Whether the GitHub release synced into this version is a draft. Present only for GH_RELEASE artifacts

prereleaseboolean

Whether the GitHub release synced into this version is a pre-release. Present only for GH_RELEASE artifacts

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

version_urlstring

Direct URL to access the artifact version content. For CONTAINER artifacts, this is the registry URL (e.g., container.registry.sh/ttests/ubuntu:latest). For FILES artifacts, this is the HTTP server URL where the content is served (e.g., https://latest-my-artifact.bucket-1.registry.sh/)

created_datestring

Version creation timestamp

Last modified on Jun 29, 2026

Create Versions Get Versions

Request example

CURL

curl -X POST "https://api.buddy.works/workspaces/:workspace/artifacts/:artifact_id/versions/:version_id/upload" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

EXAMPLE RESPONSE

{
  "url": "https://api.buddy.works/workspaces/ttests/artifacts/x5169jL2/versions/a9f84k2L",
  "html_url": "https://app.buddy.works/ttests/-/artifacts/x5169jL2/versions/a9f84k2L",
  "extracted_files": 25,
  "total_size": 10485760
}

STATUS

201 Created