img-edit-agent-api / README.md
GitHub Actions
Deploy to HF Spaces: 2025-09-06 20:27:31 UTC
235461a
|
Raw
History Blame Contribute Delete
1.5 kB
metadata
title: Img Edit Agent API
emoji: πŸ–ΌοΈ
colorFrom: indigo
colorTo: blue
sdk: docker
app_port: 7860
pinned: false

AI Image Editor API

FastAPI service powering the Img Edit Agent web app. It provides chat-driven image editing and generation.

Features

  • POST /chat – Send a message and optional image metadata; receives an AI reply with optional generated image details.
  • GET /health – Reports service and database status.
  • Rate limiting & startup hooks – Initializes a rate-limit table on startup and logs shutdown events.
  • Modular LLM tools – Uses the llm package for agent logic, database connections, and utilities.

Project Structure

api/
β”œβ”€β”€ server/         # FastAPI application
β”œβ”€β”€ llm/            # LLM agent and helpers
β”œβ”€β”€ tests/          # pytest suite
β”œβ”€β”€ Dockerfile      # Container build
└── README.md

Running Locally

pip install -e .[dev]
uvicorn server.main:app --host 0.0.0.0 --port 8000

API Reference

POST /chat

Request body:

{
  "message": "Describe edit",
  "selected_images": [{ "id": "...", "url": "..." }],
  "user_id": "optional"
}

Response:

{
  "response": "AI response",
  "status": "success",
  "generated_image": { "id": "...", "url": "..." }
}

GET /health

Returns service and database status.

Deployment

This API is built to run as a Docker container on Hugging Face Spaces.