OpenAPI 3.1.0 · contract v1.0.0

FaceSwapAI OpenAPI contract

The repository pins the exact public contract reviewed for release v1.0.0. The live production document remains authoritative when its version is newer.

Route matrix

5 authenticated route families

Generation routes accept multipart media. Matching GET operations poll task status; task history is read-only.

MethodRouteCurrent costInput boundary
POST / GET /api/v1/face-swap/imageImage 13 credits per paid task Two images, up to 30 MB each
POST / GET /api/v1/face-swap/videoVideo max(5, ceil(seconds)) credits Image plus video, up to 300 seconds and 100 MB
POST / GET /api/v1/face-swap/gifGIF max(10, ceil(seconds), ceil(frames / 10)) credits Image plus GIF, up to 30 seconds and 30 MB
POST / GET /api/v1/face-swap/multipleMultiple face 13 credits per task Group image plus 1-10 replacement faces
GET /api/v1/tasksTask history No generation charge Optional pagination, status and task-type filters

Authentication

One bearer key, account-owned tasks

Send Authorization: Bearer YOUR_API_KEY from trusted server code. A key can access only tasks owned by its account.

PENDINGPROCESSINGCOMPLETED FAILED and CANCELLED are terminal alternatives.

Evidence boundary

Contract, examples and conformance are separate

The OpenAPI file describes request and response shapes. Mocked client tests verify serialization and error handling. The dated production conformance matrix records a separate bounded observation; none is an SLA or independent certification.