API Documentation

v1

Complete reference for Solo Works REST API. Use these endpoints to integrate AI image editing into your applications.Updated: 2026-03-05

Ask AI how to use this API

Copy the prompt below and paste it to your AI assistant (ChatGPT, Claude, etc.) to get started quickly.

Read https://soloworks.app/llms.txt and tell me how to use these APIs, with code examples.
llms.txt
Authentication
All API requests require an API key sent via the Authorization header.

Base URL

https://soloworks.app/api/v1

Authorization Header

Authorization: Bearer sk_live_YOUR_API_KEY

Protocol

This is a standard REST API. Use GET for reading data and POST for executing workflows. All responses are JSON. Image inputs accept HTTP/HTTPS URLs or base64 data URLs.

Get your API key

Quick Start

  1. GET /api/v1/workflows — Discover available workflows
  2. GET /api/v1/workflows/:id — Get required inputs for a workflow
  3. POST /api/v1/workflows/:id/execute — Execute with your images and parameters
  4. GET /api/v1/executions/:id — Poll until status is completed

Discovery

GET
/api/v1/workflows
Discovery
List all available AI image editing workflows. Returns workflow IDs, names, descriptions, and credit costs.

Parameters

NameTypeInRequiredDescription
tagstringqueryOptionalOptional tag to filter workflows (e.g., 'fashion', 'product').
GET
/api/v1/workflows/{id}
Discovery
Get the detail and required input schema for a specific workflow, including image fields, text fields, and switch/selection fields. Text fields with preset options will include a presetOptions array — use values from this array when executing.

Parameters

NameTypeInRequiredDescription
idstringpathRequiredThe workflow ID to retrieve details for.

Execution

POST
/api/v1/workflows/{id}/execute
Execution
Execute an AI image editing workflow asynchronously. Returns an execution ID to poll for results via GET /api/v1/executions/:id.

Parameters

NameTypeInRequiredDescription
idstringpathRequiredThe workflow ID to execute (path parameter).
imagesRecord<string, string>bodyRequiredImage inputs as fieldId → url or base64. URLs are automatically downloaded by the server.
textsRecord<string, string>bodyOptionalText inputs as key-value pairs: fieldId → optionId (for preset fields) or free text.
switchSelectionsRecord<string, string[]>bodyOptionalSwitch/selection inputs as switchFieldId → [optionId].
globalOverrides{ aspectRatio?: string, imageSize?: string }bodyOptionalOptional output overrides. aspectRatio: "1:1", "2:3", "3:2", "3:4", "4:3", "9:16", "16:9", "21:9". imageSize: "1K" or "2K".
GET
/api/v1/executions/{id}
Execution
Check the status of a workflow execution. Returns progress percentage and result URLs when complete.

Parameters

NameTypeInRequiredDescription
idstringpathRequiredThe execution ID returned by the execute endpoint.

Account

GET
/api/v1/balance
Account
Get your current API credits balance and web credits breakdown.

This endpoint requires no parameters.

Available Workflows

These workflows are currently available via the API. Use the workflow ID with the endpoints above.

IDNameTagscredits
79c9e172-637f-44db-9beb-39092ff4d462
單色棚拍風
FashionModel
4