> ## Documentation Index > Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt > Use this file to discover all available pages before exploring further. # Modifier les images > Edit existing images using Google Gemini 2.5 Flash Image with text instructions. All requests and responses are processed through SMLTP for security and compliance. This endpoint is specifically designed for **image-to-image editing** where: - An image file is **required** (unlike `/images/generations` where it's optional) - A text prompt describes how to edit or transform the image - The edited image is returned with the same quality and format options All prompts and responses are automatically processed through SMLTP for audit logging and compliance. # Modifier les images Modifiez les images existantes à l'aide de Google Gemini 2.5 Flash Image avec des instructions textuelles. ## Point de terminaison ``` POST /images/edits ``` ## Description Modifiez les images existantes à l'aide de Google Gemini 2.5 Flash Image avec des instructions textuelles. Ce point de terminaison est spécifiquement conçu pour la **édition d'image à image** où : * Un fichier image est **obligatoire** (contrairement à `/images/generations` où il est facultatif) * Une invite textuelle décrit comment modifier ou transformer l'image * L'image éditée est renvoyée avec les mêmes options de qualité et de format Toutes les invites et réponses sont automatiquement traitées via SMLTP pour la journalisation des audits et la conformité. ## Authentification Obligatoire : clé API ```bash theme={null} Authorization: Bearer sk-your-api-key-here ``` ## Corps de la demande Ce point de terminaison accepte le format `multipart/form-data`. ### Paramètres | Paramètre | Tapez | Obligatoire | Descriptif | | ----------------- | ------- | ----------- | ------------------------------------------------------------------------------------------------------------ | | `prompt` | chaîne | Oui | Instructions textuelles décrivant comment modifier ou transformer l'image téléchargée (1 à 4 000 caractères) | | `image` | binaire | Oui | Fichier image à modifier (JPEG, PNG, WEBP ou GIF, max 10 Mo) | | `smltp_policy` | chaîne | Non | Politique de sécurité SMLTP (par défaut : "interne") | | `response_format` | chaîne | Non | Format de réponse : "url" ou "b64\_json" (par défaut : "url") | ## Exemples de requêtes ### boucle ```bash theme={null} curl -X POST "https://{customer.name}.hiperai.ai/api/external/images/edits" \ -H "Authorization: Bearer sk-your-api-key-here" \ -F "prompt=Add dramatic sunset colors to the sky and enhance the overall atmosphere" \ -F "image=@/path/to/image.jpg" \ -F "smltp_policy=internal" \ -F "response_format=url" ``` ### JavaScript/Node.js ```javascript theme={null} const formData = new FormData(); formData.append('prompt', 'Add dramatic sunset colors to the sky and enhance the overall atmosphere'); formData.append('image', fileInput.files[0]); formData.append('smltp_policy', 'internal'); formData.append('response_format', 'url'); const response = await fetch('https://{customer.name}.hiperai.ai/api/external/images/edits', { method: 'POST', headers: { 'Authorization': 'Bearer sk-your-api-key-here' }, body: formData }); const data = await response.json(); console.log('Edited image URL:', data.data[0].url); ``` \###Python ```python theme={null} import requests url = "https://{customer.name}.hiperai.ai/api/external/images/edits" headers = { "Authorization": "Bearer sk-your-api-key-here" } with open('image.jpg', 'rb') as f: files = {'image': f} data = { 'prompt': 'Add dramatic sunset colors to the sky and enhance the overall atmosphere', 'smltp_policy': 'internal', 'response_format': 'url' } response = requests.post(url, headers=headers, files=files, data=data) result = response.json() print('Edited image URL:', result['data'][0]['url']) ``` ## Réponse ### Réponse réussie (200) ```json theme={null} { "success": true, "id": "f55bb4aa-ad9a-4b5a-9c94-511bf6fce806", "object": "image.edit", "created": 1705312200, "data": [ { "url": "http://localhost:5173/uploads/secureai_image_api_edit_68c5c6d2d57c85b102eb05e2_f55bb4aa_0.png", "revised_prompt": "Add dramatic sunset colors to the sky and enhance the overall atmosphere" } ], "metadata": { "model": "google/gemini-2.5-flash-image-preview", "provider": "Google", "total_images": 1, "is_image_to_image": true, "text_response": null, "smltp_trace_id": "trx-6caec994-73af-4f2c-9e13-572d53262f2a", "smltp_bundle_id": "jti-26464307-d455-4a3d-9ca4-8ec144cb601c", "smltp_policy": "internal" } } ``` ### Champs de réponse | Champ | Tapez | Descriptif | | ---------- | ------- | ----------------------------------------------------- | | `success` | booléen | Toujours vrai pour les demandes réussies | | `id` | chaîne | Identifiant unique de la demande | | `object` | chaîne | Type d'objet : "image.edit" | | `created` | entier | Horodatage Unix du moment où l'image a été modifiée | | `data` | tableau | Tableau d'images éditées | | `metadata` | objet | Métadonnées supplémentaires, y compris le suivi SMLTP | ### Objet image | Champ | Tapez | Descriptif | | ---------------- | ------ | -------------------------------------------------------------------------- | | `url` | chaîne | URL pour accéder à l'image modifiée (lorsque format\_réponse est "url") | | `b64_json` | chaîne | Données d'image codées en base64 (lorsque format\_réponse est "b64\_json") | | `revised_prompt` | chaîne | L'invite réellement utilisée pour l'édition (peut différer de l'entrée) | ### Objet de métadonnées | Champ | Tapez | Descriptif | | ------------------- | ------------ | --------------------------------------------------------- | | `model` | chaîne | Modèle utilisé : "google/gemini-2.5-flash-image-preview" | | `provider` | chaîne | Fournisseur : "Google" | | `total_images` | entier | Nombre total d'images (toujours 1 pour les modifications) | | `is_image_to_image` | booléen | Toujours vrai pour ce point de terminaison | | `text_response` | chaîne\|null | Réponse textuelle facultative du modèle | | `smltp_trace_id` | chaîne | ID de trace SMLTP pour le suivi des audits | | `smltp_bundle_id` | chaîne | ID du bundle SMLTP pour le suivi des audits | | `smltp_policy` | chaîne | Stratégie SMLTP appliquée | ## Réponses d'erreur ### 400 Requête incorrecte ```json theme={null} { "success": false, "error": "Missing image", "message": "An image file is required for image-to-image editing", "request_id": "f55bb4aa-ad9a-4b5a-9c94-511bf6fce806" } ``` ### 401 Non autorisé ```json theme={null} { "success": false, "error": "Invalid API key", "message": "The provided API key is invalid or has been revoked" } ``` ### 403 Interdit ```json theme={null} { "success": false, "error": "Access denied", "message": "SMLTP policy not allowed" } ``` ### 413 Charge utile trop importante ```json theme={null} { "success": false, "error": "File too large", "message": "Maximum image size is 10MB", "request_id": "f55bb4aa-ad9a-4b5a-9c94-511bf6fce806" } ``` ### 500 Erreur de serveur interne ```json theme={null} { "success": false, "error": "Internal server error", "message": "Image editing failed" } ``` ### 503 Service indisponible ```json theme={null} { "success": false, "error": "Service unavailable", "message": "Image generation service is not configured", "request_id": "f55bb4aa-ad9a-4b5a-9c94-511bf6fce806" } ``` ## Remarques * Formats d'images pris en charge : JPEG, PNG, WEBP, GIF * Taille maximale du fichier : 10 Mo par image * Le fichier image est **obligatoire** pour ce point de terminaison (contrairement à `/images/generations`) * L'invite décrit comment modifier ou transformer l'image téléchargée * Toutes les demandes sont traitées via SMLTP pour des raisons de sécurité et de conformité * Utilisez `response_format: "b64_json"` pour recevoir des données d'image codées en base64 au lieu d'URL ## OpenAPI ````yaml POST /images/edits openapi: 3.0.3 info: title: SecureAI External API description: > SecureAI External API provides AI chat completion and image generation capabilities with knowledge base retrieval, security policies, and comprehensive usage tracking. This API is designed for external developers and integrations using API key authentication. ## Key Features - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge bases for relevant context - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI models - **Model Redundancy & Failover**: Caller-defined failover chains (primary + fallbacks) with per-attempt timeouts - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1` — no code changes - **Image Generation**: Generate and edit images using Google Gemini 2.5 Flash Image - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI Realtime API with WebRTC - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield, and signed compliance receipts - **Usage Tracking**: Comprehensive usage monitoring, self-service quota, and rate limiting - **Knowledge Base Integration**: Access to personal and shared knowledge bases - **User Management**: Complete user, group, and role management capabilities - **Audit Logging**: Comprehensive activity and security audit logs ## Authentication All endpoints (except health check) require API key authentication using Bearer token: ``` Authorization: Bearer sk-your-api-key-here ``` ## Billing and Usage By default, API requests are billed to the user account that owns the API key. You can specify a different user to bill by including the `user_id` parameter in your request. This allows for: - Multi-tenant applications with per-user billing - Flexible completion limit management - Per-user "Usage by Model" settings ## Rate Limits - Default: 60 requests per minute, 1000 requests per hour - Daily limits: 100 requests (configurable) - Monthly limits: 10,000 requests (configurable) ## Base URL ``` https://secureai.hiperai.ai/api/external ``` version: 1.1.0 contact: name: SecureAI Support email: support@secureai.hiperai.ai license: name: Proprietary url: https://secureai.hiperai.ai/terms servers: - url: https://secureai.hiperai.ai/api/external description: Production server - url: http://localhost:3010/api/external description: Development server security: - ApiKeyAuth: [] tags: - name: System description: System health and status endpoints - name: Discovery description: Endpoints to discover available models, indexes, and policies - name: Chat description: AI chat completion endpoints - name: User Management description: Endpoints for managing user accounts and roles - name: Index Management description: Endpoints for managing knowledge base indexes - name: Group Management description: Endpoints for managing user groups - name: SMLTP Security description: Endpoints for managing SMLTP security policies and audit logs - name: Role Management description: Endpoints for managing user roles - name: Activity Logs description: Endpoints for retrieving activity logs externalDocs: description: SecureAI Documentation url: https://secureai.hiperai.ai/docs paths: /images/edits: post: tags: - Images summary: Image-to-Image Editing description: > Edit existing images using Google Gemini 2.5 Flash Image with text instructions. All requests and responses are processed through SMLTP for security and compliance. This endpoint is specifically designed for **image-to-image editing** where: - An image file is **required** (unlike `/images/generations` where it's optional) - A text prompt describes how to edit or transform the image - The edited image is returned with the same quality and format options All prompts and responses are automatically processed through SMLTP for audit logging and compliance. requestBody: required: true content: multipart/form-data: schema: type: object required: - prompt - image properties: prompt: type: string description: >- Text instructions describing how to edit or transform the uploaded image example: >- Add dramatic sunset colors to the sky and enhance the overall atmosphere minLength: 1 maxLength: 4000 image: type: string format: binary description: >- Image file to edit (required, JPEG, PNG, WEBP, or GIF, max 10MB) smltp_policy: type: string description: >- SMLTP security policy to apply (e.g., 'internal', 'public', 'confidential', 'hipaa', 'gdpr') default: internal example: internal response_format: type: string description: The format of the response images enum: - url - b64_json default: url example: url responses: '200': description: Image edited successfully content: application/json: schema: type: object properties: success: type: boolean example: true id: type: string description: Unique request identifier example: f55bb4aa-ad9a-4b5a-9c94-511bf6fce806 object: type: string example: image.edit created: type: integer description: Unix timestamp of when the image was edited example: 1705312200 data: type: array description: Array of edited images items: type: object properties: url: type: string format: uri description: >- URL to access the edited image (when response_format is 'url') example: >- http://localhost:5173/uploads/secureai_image_api_edit_68c5c6d2d57c85b102eb05e2_f55bb4aa_0.png b64_json: type: string description: >- Base64-encoded image data (when response_format is 'b64_json') example: iVBORw0KGgoAAAANSUhEUgAA... revised_prompt: type: string description: >- The prompt that was actually used for editing (may differ from input) example: >- Add dramatic sunset colors to the sky and enhance the overall atmosphere metadata: type: object properties: model: type: string example: google/gemini-2.5-flash-image-preview provider: type: string example: Google total_images: type: integer example: 1 is_image_to_image: type: boolean description: Always true for this endpoint example: true text_response: type: string nullable: true description: Optional text response from the model example: null smltp_trace_id: type: string description: SMLTP trace ID for audit tracking example: trx-6caec994-73af-4f2c-9e13-572d53262f2a smltp_bundle_id: type: string description: SMLTP bundle ID for audit tracking example: jti-26464307-d455-4a3d-9ca4-8ec144cb601c smltp_policy: type: string description: SMLTP policy that was applied example: internal example: success: true id: f55bb4aa-ad9a-4b5a-9c94-511bf6fce806 object: image.edit created: 1705312200 data: - url: >- http://localhost:5173/uploads/secureai_image_api_edit_68c5c6d2d57c85b102eb05e2_f55bb4aa_0.png revised_prompt: >- Add dramatic sunset colors to the sky and enhance the overall atmosphere metadata: model: google/gemini-2.5-flash-image-preview provider: Google total_images: 1 is_image_to_image: true text_response: null smltp_trace_id: trx-6caec994-73af-4f2c-9e13-572d53262f2a smltp_bundle_id: jti-26464307-d455-4a3d-9ca4-8ec144cb601c smltp_policy: internal '400': description: >- Invalid request parameters (missing prompt, missing image, invalid image format, etc.) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: Missing image message: An image file is required for image-to-image editing request_id: f55bb4aa-ad9a-4b5a-9c94-511bf6fce806 '401': description: Invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Access denied (SMLTP policy not allowed) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '413': description: Image file too large (maximum 10MB) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: File too large message: Maximum image size is 10MB request_id: f55bb4aa-ad9a-4b5a-9c94-511bf6fce806 '500': description: Internal server error or image editing failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: Image generation service unavailable (Gemini service not configured) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: Service unavailable message: Image generation service is not configured request_id: f55bb4aa-ad9a-4b5a-9c94-511bf6fce806 security: - ApiKeyAuth: [] components: schemas: ErrorResponse: type: object properties: success: type: boolean example: false error: type: string example: Invalid API key message: type: string example: The provided API key is invalid or has been revoked request_id: type: string example: req-abc123 description: Request ID for tracking (if available) securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key authentication using Bearer token format. Example: `Authorization: Bearer sk-your-api-key-here` ````