File size: 14,551 Bytes
8062d6a |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 |
openapi: 3.0.3
info:
title: BackgroundFX Pro API
description: |
AI-powered background removal and replacement API.
## Authentication
All API requests require authentication using Bearer tokens.
## Rate Limiting
- Free tier: 100 requests/hour
- Pro tier: 1000 requests/hour
- Enterprise: Unlimited
## File Limits
- Images: 50MB max
- Videos: 500MB max
- Batch: 100 files max
version: 1.0.0
contact:
email: api@backgroundfx.pro
url: https://backgroundfx.pro
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: https://api.backgroundfx.pro/v1
description: Production server
- url: https://staging-api.backgroundfx.pro/v1
description: Staging server
- url: http://localhost:8000/v1
description: Local development
security:
- BearerAuth: []
tags:
- name: Authentication
description: User authentication and authorization
- name: Processing
description: Image and video processing operations
- name: Projects
description: Project management
- name: Backgrounds
description: Background library and generation
- name: Users
description: User profile and settings
- name: Webhooks
description: Webhook management
paths:
/auth/login:
post:
tags: [Authentication]
summary: User login
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [email, password]
properties:
email:
type: string
format: email
password:
type: string
minLength: 8
responses:
200:
description: Successful login
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
401:
$ref: '#/components/responses/Unauthorized'
/auth/register:
post:
tags: [Authentication]
summary: Register new user
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [email, password, name]
properties:
email:
type: string
format: email
password:
type: string
minLength: 8
name:
type: string
minLength: 2
responses:
201:
description: User created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/AuthResponse'
400:
$ref: '#/components/responses/BadRequest'
/process/remove-background:
post:
tags: [Processing]
summary: Remove background from image
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required: [file]
properties:
file:
type: string
format: binary
description: Image file (PNG, JPG, WebP)
model:
type: string
enum: [rembg, u2net, deeplab, custom]
default: rembg
quality:
type: string
enum: [low, medium, high, ultra]
default: high
return_mask:
type: boolean
default: false
edge_refinement:
type: number
minimum: 0
maximum: 100
default: 50
responses:
200:
description: Background removed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessingResult'
400:
$ref: '#/components/responses/BadRequest'
413:
$ref: '#/components/responses/PayloadTooLarge'
/process/batch:
post:
tags: [Processing]
summary: Process multiple files
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required: [files]
properties:
files:
type: array
items:
type: string
format: binary
maxItems: 100
options:
type: string
description: JSON string of processing options
responses:
202:
description: Batch job created
content:
application/json:
schema:
$ref: '#/components/schemas/BatchJob'
/process/jobs/{jobId}:
get:
tags: [Processing]
summary: Get batch job status
parameters:
- name: jobId
in: path
required: true
schema:
type: string
format: uuid
responses:
200:
description: Job status retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/BatchJob'
404:
$ref: '#/components/responses/NotFound'
/process/replace-background:
post:
tags: [Processing]
summary: Replace image background
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [image_id, background_id]
properties:
image_id:
type: string
background_id:
type: string
blend_mode:
type: string
enum: [normal, multiply, screen, overlay]
default: normal
responses:
200:
description: Background replaced successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessingResult'
/backgrounds:
get:
tags: [Backgrounds]
summary: List available backgrounds
parameters:
- name: category
in: query
schema:
type: string
enum: [solid, gradient, pattern, nature, abstract, custom]
- name: page
in: query
schema:
type: integer
default: 1
- name: limit
in: query
schema:
type: integer
default: 20
maximum: 100
responses:
200:
description: List of backgrounds
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Background'
total:
type: integer
page:
type: integer
pages:
type: integer
/backgrounds/generate:
post:
tags: [Backgrounds]
summary: Generate AI background
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [prompt]
properties:
prompt:
type: string
minLength: 3
maxLength: 500
style:
type: string
enum: [realistic, artistic, abstract, gradient]
default: realistic
width:
type: integer
default: 1920
height:
type: integer
default: 1080
responses:
201:
description: Background generated
content:
application/json:
schema:
$ref: '#/components/schemas/Background'
/projects:
get:
tags: [Projects]
summary: List user projects
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/LimitParam'
- name: search
in: query
schema:
type: string
responses:
200:
description: List of projects
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/Project'
total:
type: integer
post:
tags: [Projects]
summary: Create new project
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [name, type]
properties:
name:
type: string
type:
type: string
enum: [image, video, batch]
description:
type: string
responses:
201:
description: Project created
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
/webhooks:
post:
tags: [Webhooks]
summary: Register webhook
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [url, events]
properties:
url:
type: string
format: uri
events:
type: array
items:
type: string
enum: [job.completed, job.failed, project.created]
secret:
type: string
responses:
201:
description: Webhook registered
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
parameters:
PageParam:
name: page
in: query
schema:
type: integer
default: 1
minimum: 1
LimitParam:
name: limit
in: query
schema:
type: integer
default: 20
minimum: 1
maximum: 100
schemas:
AuthResponse:
type: object
properties:
token:
type: string
refresh_token:
type: string
user:
$ref: '#/components/schemas/User'
User:
type: object
properties:
id:
type: string
format: uuid
email:
type: string
format: email
name:
type: string
plan:
type: string
enum: [free, pro, enterprise]
created_at:
type: string
format: date-time
ProcessingResult:
type: object
properties:
id:
type: string
format: uuid
image:
type: string
format: uri
mask:
type: string
format: uri
metadata:
type: object
properties:
width:
type: integer
height:
type: integer
format:
type: string
processing_time:
type: number
BatchJob:
type: object
properties:
id:
type: string
format: uuid
status:
type: string
enum: [pending, processing, completed, failed]
progress:
type: number
minimum: 0
maximum: 100
total_files:
type: integer
processed_files:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/ProcessingResult'
created_at:
type: string
format: date-time
Background:
type: object
properties:
id:
type: string
url:
type: string
format: uri
thumbnail:
type: string
format: uri
category:
type: string
tags:
type: array
items:
type: string
Project:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
type:
type: string
enum: [image, video, batch]
status:
type: string
enum: [draft, processing, completed]
files_count:
type: integer
created_at:
type: string
format: date-time
Webhook:
type: object
properties:
id:
type: string
format: uuid
url:
type: string
format: uri
events:
type: array
items:
type: string
active:
type: boolean
created_at:
type: string
format: date-time
Error:
type: object
properties:
error:
type: string
message:
type: string
details:
type: object
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
PayloadTooLarge:
description: File too large
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
RateLimitExceeded:
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/Error' |