Skip to main content
POST
/
api
/
run
curl -X POST https://api.artificialstudio.ai/api/run \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{
    "tool": "create-image",
    "input": {
      "prompt": "A serene Japanese garden with cherry blossoms"
    }
  }'
{
  "id": "507f1f77bcf86cd799439011",
  "status": "processing",
  "tool": "create-image",
  "createdAt": "2024-01-15T10:30:00.000Z"
}
Create a new generation by specifying a tool and input parameters. Returns immediately with a generation ID while processing happens asynchronously.

Headers

NameTypeRequiredDescription
AuthorizationstringYesYour API key
Content-TypestringYesMust be application/json

Body

ParameterTypeRequiredDescription
toolstringYesTool identifier (e.g., create-image, create-video). Use GET /api/tools to list available tools
inputobjectYesTool-specific parameters
input.modelstringNoModel to use. Defaults to the tool’s primary model
input.promptstringVariesText prompt for generation
webhookstringNoHTTPS URL to receive completion notifications
The request body is validated strictly — unknown fields will be rejected with a 400 error.

Response Fields

FieldTypeDescription
idstringUnique generation identifier
statusstringInitial status (processing)
toolstringTool used for this generation
createdAtstringISO 8601 timestamp
curl -X POST https://api.artificialstudio.ai/api/run \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{
    "tool": "create-image",
    "input": {
      "prompt": "A serene Japanese garden with cherry blossoms"
    }
  }'
{
  "id": "507f1f77bcf86cd799439011",
  "status": "processing",
  "tool": "create-image",
  "createdAt": "2024-01-15T10:30:00.000Z"
}