Compress images

View as Markdown

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Request

URL PARAMETERS

workspacerequiredstring

The workspace name.

pipeline_idrequiredinteger

The numerical ID of the desired pipeline.

project_namerequiredstring

The name ID of the project.

POST PARAMETERS

namerequiredstring

The name of the action.

typerequiredstring

The type of the action. Should be set to IMAGE_COMPRESSION.

local_pathrequiredstring

The path in the repository.

destinationrequiredstring

Output directory for compressed images.

levelrequiredstring

The level of image compression. Can be set to 1 (low), 2 (medium) or 3 (high).

typesrequiredstring

Supported image formats. Available types: jpg, png, gif, svg.

Last modified on Jan 19, 2026

CodeDeploy Contentful CLI

Request example


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Compress images",
  "type": "IMAGE_COMPRESSION",
  "trigger_time": "ON_EVERY_EXECUTION",
  "local_path": "/local",
  "destination": "/destination",
  "level": "1",
  "types": "jpg,png,gif,svg"
}'

Response

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
  "id": 2,
  "name": "Compression images",
  "type": "IMAGE_COMPRESSION",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "local_path": "/assets",
  "destination": "/destination",
  "level": "1",
  "types": "jpg,png,gif,svg",
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "test server",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created