Skip to content

README_EN.md

Latest commit

 

History

History
305 lines (229 loc) · 9.12 KB

README_EN.md

File metadata and controls

305 lines (229 loc) · 9.12 KB

adobe2api

✨ Ad Spot (o゜▽゜)o☆

This is my independently built and actively maintained personal website: Pixelle Labs

I share AI creative tools, image/video mini-products, and fun experiments here. You are welcome to explore, try everything out, and play around (๑•̀ㅂ•́)و✧. Feedback, ideas, and collaboration discussions are always appreciated! ヾ(≧▽≦*)o

Adobe Firefly/OpenAI-compatible gateway service.

Chinese README: README.md

Current design:

  • External unified entry: /v1/chat/completions (image + video)
  • Optional image-only endpoint: /v1/images/generations
  • Token pool management (manual token + auto-refresh token)
  • Admin web UI: token/config/logs/refresh profile import

1) Deployment

A. Local Run

  1. Install dependencies:
pip install -r requirements.txt
  1. Start service (run in adobe2api/):
uvicorn app:app --host 0.0.0.0 --port 6001 --reload
  1. Access Admin UI:
  • URL: http://127.0.0.1:6001/
  • Default login: admin / admin
  • You can change credentials in "系统配置" (System Config) or edit config/config.json

B. Docker Deployment (Recommended)

This project provides Docker support. It is recommended to use Docker Compose for one-click deployment:

docker compose up -d --build

2) Auth to this service

Service API key is configured in config/config.json (api_key).

  • If set, call with either:
    • Authorization: Bearer <api_key>
    • X-API-Key: <api_key>

Admin UI and admin APIs require login session cookie via /api/v1/auth/login.

3) External API usage

3.0 Supported model families

Current supported model families are:

  • firefly-nano-banana-* (image, maps to upstream nano-banana-2)
  • firefly-nano-banana2-* (image, maps to upstream nano-banana-3)
  • firefly-nano-banana-pro-* (image)
  • firefly-sora2-* (video)
  • firefly-sora2-pro-* (video)
  • firefly-veo31-* (video)
  • firefly-veo31-ref-* (video, reference-image mode)
  • firefly-veo31-fast-* (video)

Nano Banana image models (nano-banana-2):

  • Pattern: firefly-nano-banana-{resolution}-{ratio}
  • Resolution: 1k / 2k / 4k
  • Ratio suffix: 1x1 / 16x9 / 9x16 / 4x3 / 3x4
  • Examples:
    • firefly-nano-banana-2k-16x9
    • firefly-nano-banana-4k-1x1

Nano Banana 2 image models (nano-banana-3):

  • Pattern: firefly-nano-banana2-{resolution}-{ratio}
  • Resolution: 1k / 2k / 4k
  • Ratio suffix: 1x1 / 16x9 / 9x16 / 4x3 / 3x4
  • Examples:
    • firefly-nano-banana2-2k-16x9
    • firefly-nano-banana2-4k-1x1

Nano Banana Pro image models (legacy-compatible):

  • Pattern: firefly-nano-banana-pro-{resolution}-{ratio}
  • Resolution: 1k / 2k / 4k
  • Ratio suffix: 1x1 / 16x9 / 9x16 / 4x3 / 3x4
  • Examples:
    • firefly-nano-banana-pro-2k-16x9
    • firefly-nano-banana-pro-4k-1x1

Sora2 video models:

  • Pattern: firefly-sora2-{duration}-{ratio}
  • Duration: 4s / 8s / 12s
  • Ratio: 9x16 / 16x9
  • Examples:
    • firefly-sora2-4s-16x9
    • firefly-sora2-8s-9x16

Sora2 Pro video models:

  • Pattern: firefly-sora2-pro-{duration}-{ratio}
  • Duration: 4s / 8s / 12s
  • Ratio: 9x16 / 16x9
  • Examples:
    • firefly-sora2-pro-4s-16x9
    • firefly-sora2-pro-8s-9x16

Veo31 video models:

  • Pattern: firefly-veo31-{duration}-{ratio}-{resolution}
  • Duration: 4s / 6s / 8s
  • Ratio: 16x9 / 9x16
  • Resolution: 1080p / 720p
  • Supports up to 2 reference images:
    • 1 image: first-frame reference
    • 2 images: first-frame + last-frame reference
  • Audio defaults to enabled
  • Examples:
    • firefly-veo31-4s-16x9-1080p
    • firefly-veo31-6s-9x16-720p

Veo31 Ref video models (reference-image mode):

  • Pattern: firefly-veo31-ref-{duration}-{ratio}-{resolution}
  • Duration: 4s / 6s / 8s
  • Ratio: 16x9 / 9x16
  • Resolution: 1080p / 720p
  • Always uses reference image mode (not first/last frame mode)
  • Supports up to 3 reference images (mapped to upstream referenceBlobs[].usage="asset")
  • Examples:
    • firefly-veo31-ref-4s-9x16-720p
    • firefly-veo31-ref-6s-16x9-1080p
    • firefly-veo31-ref-8s-9x16-1080p

Veo31 Fast video models:

  • Pattern: firefly-veo31-fast-{duration}-{ratio}-{resolution}
  • Duration: 4s / 6s / 8s
  • Ratio: 16x9 / 9x16
  • Resolution: 1080p / 720p
  • Supports up to 2 reference images:
    • 1 image: first-frame reference
    • 2 images: first-frame + last-frame reference
  • Audio defaults to enabled
  • Examples:
    • firefly-veo31-fast-4s-16x9-1080p
    • firefly-veo31-fast-6s-9x16-720p

3.1 List models

curl -X GET "http://127.0.0.1:6001/v1/models" \
  -H "Authorization: Bearer <service_api_key>"

3.2 Unified endpoint: /v1/chat/completions

Text-to-image:

curl -X POST "http://127.0.0.1:6001/v1/chat/completions" \
  -H "Authorization: Bearer <service_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "firefly-nano-banana-pro-2k-16x9",
    "messages": [{"role":"user","content":"a cinematic mountain sunrise"}]
  }'

Image-to-image (pass image in latest user message):

curl -X POST "http://127.0.0.1:6001/v1/chat/completions" \
  -H "Authorization: Bearer <service_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "firefly-nano-banana-pro-2k-16x9",
    "messages": [{
      "role":"user",
      "content":[
        {"type":"text","text":"turn this photo into watercolor style"},
        {"type":"image_url","image_url":{"url":"https://example.com/input.jpg"}}
      ]
    }]
  }'

Text-to-video:

curl -X POST "http://127.0.0.1:6001/v1/chat/completions" \
  -H "Authorization: Bearer <service_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "firefly-sora2-4s-16x9",
    "messages": [{"role":"user","content":"a drone shot over snowy forest"}]
  }'

Veo31 single-image semantics:

  • firefly-veo31-* / firefly-veo31-fast-*: frame mode
    • 1 image => first frame
    • 2 images => first frame + last frame
  • firefly-veo31-ref-*: reference-image mode
    • 1~3 images => reference images

Image-to-video:

curl -X POST "http://127.0.0.1:6001/v1/chat/completions" \
  -H "Authorization: Bearer <service_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "firefly-sora2-8s-9x16",
    "messages": [{
      "role":"user",
      "content":[
        {"type":"text","text":"animate this character walking forward"},
        {"type":"image_url","image_url":{"url":"https://example.com/character.png"}}
      ]
    }]
  }'

3.3 Image endpoint: /v1/images/generations

curl -X POST "http://127.0.0.1:6001/v1/images/generations" \
  -H "Authorization: Bearer <service_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "firefly-nano-banana-pro-4k-16x9",
    "prompt": "futuristic city skyline at dusk"
  }'

4) Cookie Import

Step 1: Export using the Browser Extension (Recommended)

This project includes a companion browser extension to help you easily export required cookies from the Adobe Firefly page.

  • Extension source: browser-cookie-exporter/
  • Exports a minimal cookie_*.json (containing only the cookie field)
  • Detailed instructions: browser-cookie-exporter/README.md

Installation & Usage:

  1. Open Chrome or Edge extension management: chrome://extensions
  2. Enable "Developer mode" in the top right
  3. Click "Load unpacked" and select the browser-cookie-exporter/ directory from this project
  4. Log in to Adobe Firefly as usual
  5. Click the extension icon in your browser toolbar and select the export scope
  6. Click "Export Minimal JSON" and save the file

Step 2: Import into the Project

Once you have the exported JSON file, follow these steps to import it:

  1. Access and log in to the admin UI (default http://127.0.0.1:6001/)
  2. Navigate to the "Token 管理" (Token Management) tab
  3. Click the "导入 Cookie" (Import Cookie) button
  4. Option A: Paste the JSON content into the text box; Option B: Upload the exported .json file directly
  5. Click "Confirm Import" (the service will verify the cookies and run an initial refresh)
  6. Upon success, the token will appear in the list with 自动刷新 (Auto Refresh) set to "Yes"

Batch Import: The import dialog supports uploading multiple files at once or pasting a JSON array containing multiple account credentials.

5) Storage Paths

  • Generated media: data/generated/
  • Request logs: data/request_logs.jsonl
  • Token pool: config/tokens.json
  • Service config: config/config.json
  • Refresh profile (local private): config/refresh_profile.json

Generated media retention policy:

  • Files under data/generated/ are preserved and served via /generated/*
  • Auto-prune is enabled by size threshold (oldest files first)
    • generated_max_size_mb (default 1024)
    • generated_prune_size_mb (default 200)
  • When total generated file size exceeds generated_max_size_mb, service deletes old files until at least generated_prune_size_mb is reclaimed and total size falls back under threshold

Star History

Star History Chart