Skip to main content
POST
/
api
/
v1
/
image-rewrite
TypeScript
async function processImages(
  imageUrls: string[],
  parameters: object,
  apiKey: string
): Promise<any> {
  const baseUrl = 'https://www.topyappers.com';

  const response = await fetch(`${baseUrl}/api/v1/image-rewrite`, {
    method: 'POST',
    headers: {
      'x-ty-api-key': apiKey,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      images: imageUrls.map((imageUrl) => ({ image_url: imageUrl })),
      parameters,
    }),
  });

  if (!response.ok) {
    throw new Error(`API error: ${response.status}`);
  }

  return await response.json();
}

// Usage
const result = await processImages(
  ['https://example.com/image-1.jpg', 'https://example.com/image-2.jpg'],
  { brightness: 0.02, contrast: 1.05, quality: 94 },
  'YOUR_API_KEY'
);
{
  "success": true,
  "message": "Images processed successfully",
  "data": {
    "imageCount": 2,
    "inputImageUrls": [
      "https://example.com/image-1.jpg",
      "https://example.com/image-2.jpg"
    ],
    "parameters": {
      "brightness": 0.02,
      "contrast": 1.05,
      "quality": 94
    },
    "result": {
      "metadata": {
        "tool_time": 8.42,
        "count": 2
      },
      "data": {
        "results": [
          {
            "url": "https://imgrework.topyappers.com/processed-image-1.jpg",
            "applied_params": {
              "brightness": 0.02,
              "contrast": 1.05,
              "quality": 94
            }
          },
          {
            "url": "https://imgrework.topyappers.com/processed-image-2.jpg",
            "applied_params": {
              "brightness": 0.02,
              "contrast": 1.05,
              "quality": 94
            }
          }
        ]
      }
    },
    "processedImages": [
      {
        "url": "https://imgrework.topyappers.com/processed-image-1.jpg",
        "applied_params": {
          "brightness": 0.02,
          "contrast": 1.05,
          "quality": 94
        }
      },
      {
        "url": "https://imgrework.topyappers.com/processed-image-2.jpg",
        "applied_params": {
          "brightness": 0.02,
          "contrast": 1.05,
          "quality": 94
        }
      }
    ],
    "appliedParameters": [
      {
        "brightness": 0.02,
        "contrast": 1.05,
        "quality": 94
      },
      {
        "brightness": 0.02,
        "contrast": 1.05,
        "quality": 94
      }
    ],
    "processingTime": 8.42
  }
}

Authorizations

​
x-ty-api-key
string
header
required

API key for TopYappers API authentication

Body

application/json

Image processing request. Send either image_url for a single image or images for a batch of up to 20 images.

​
image_url
string<uri>
required

Publicly accessible URL to a single image file

Example:

"https://example.com/image.jpg"

​
images
object[]

Batch of image URLs and optional image-specific parameters

Required array length: 1 - 20 elements
​
parameters
object

Optional image processing parameters. Global parameters apply to every image unless an image includes its own value.

Example:
{
  "brightness": 0.02,
  "contrast": 1.05,
  "saturation": 1.03,
  "hue": 2,
  "quality": 94,
  "zoomFactor": 1.02,
  "deviceModel": "iPhone 16 Pro"
}

Response

Images processed successfully

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Images processed successfully"

​
data
object
required