Sessions API

Endpoints for managing image processing sessions.

Overview

Every processing batch creates a session — a temporary workspace that holds uploaded images, analysis results, and exported files. Sessions are identified by a unique sessionId.

Create Session & Upload Images

Upload images to create a new processing session.

Request

Response

curl -X POST \
     -H "X-API-Key: sk-your-key-here" \
     -F "images[][email protected]" \
     -F "images[][email protected]" \
     https://your-api-domain.com/image-forge-api/v1/sessions/upload

Method: POSTPath: /v1/sessions/uploadContent-Type: multipart/form-dataAuthentication: Required

Response Fields

Field	Type	Description
`sessionId`	`string`	Unique session identifier for subsequent API calls
`images`	`array`	Array of uploaded image records
`images[].id`	`string`	Unique image ID within the session
`images[].originalFilename`	`string`	Original filename as uploaded
`images[].size`	`number`	File size in bytes
`images[].width`	`number`	Image width in pixels
`images[].height`	`number`	Image height in pixels
`images[].uploadPath`	`string`	Server-side path for the uploaded file

Session Lifecycle

Upload → Analyze → Export → Download → Cleanup

Upload — Creates the session and stores files
Analyze — AI processes images (optional, depending on pipeline mode)
Export — Compresses and converts images
Download — WordPress plugin downloads processed files
Cleanup — Session files are automatically cleaned up after a period of inactivity

Sessions expire after 24 hours of inactivity. Ensure you complete the full pipeline within this window.

Credits API

Endpoints for checking credit balance and validating credit availability.

Analyze API

Endpoints for AI image analysis.

On This Page

Overview
Create Session & Upload Images
- Response Fields
Session Lifecycle

Get Picture Optimizer Report an Issue