Passer au contenu principal
POST
/
v1
/
images
/
generations
curl --request POST \
  --url https://api.apimart.ai/v1/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-image-2",
    "prompt": "A ginger cat sitting on a windowsill watching the sunset, watercolor style",
    "n": 1,
    "size": "16:9",
    "resolution": "2k"
  }'
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KPQ7J7DWB7QZ3WCEK3YVPBRA"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

curl --request POST \
  --url https://api.apimart.ai/v1/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "gpt-image-2",
    "prompt": "A ginger cat sitting on a windowsill watching the sunset, watercolor style",
    "n": 1,
    "size": "16:9",
    "resolution": "2k"
  }'
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KPQ7J7DWB7QZ3WCEK3YVPBRA"
    }
  ]
}

Autorisations

Authorization
string
requis
Tous les points de terminaison nécessitent une authentification Bearer TokenObtenir votre clé API :Rendez-vous sur la page de gestion des clés API pour obtenir votre clé APIIncluez-la dans l’en-tête de la requête :
Authorization: Bearer YOUR_API_KEY

Body

model
string
défaut:"gpt-image-2"
requis
Nom du modèle de génération d’imagesFixé à gpt-image-2
prompt
string
requis
Description textuelle pour la génération d’images
  • Prend en charge l’anglais et le chinois, des descriptions détaillées sont recommandées
  • Modération de contenu / examen de sécurité avant soumission — les violations sont rejetées immédiatement
n
integer
défaut:"1"
Nombre d’images à générerPlage : 1
Doit être un nombre brut (par exemple 1), ne pas mettre entre guillemets
size
string
défaut:"1:1"
Ratio d’aspect de l’imageRatios pris en charge, plus auto pour laisser le serveur choisir automatiquement un ratio adapté :
sizeType
autoAutomatique
1:1Carré
3:2Paysage
2:3Portrait
4:3Paysage
3:4Portrait
5:4Paysage
4:5Portrait
16:9Paysage
9:16Portrait
2:1Paysage
1:2Portrait
3:1Paysage
1:3Portrait
21:9Paysage
9:21Portrait
Les dimensions en pixels peuvent également être transmises directement, par exemple 1881x836 / 887x1774.
Lorsque size est défini sur auto, le ratio par défaut est 1:1.
resolution
string
défaut:"1k"
Niveau de résolution de sortieOptions : 1k / 2k / 4kCorrespondance size × resolution → pixels réels :
size1k2k4k
1:11024×1024 / 1254×12542048×20482880×2880
3:21536×10242048×13603520×2336
2:31024×15361360×20482336×3520
4:31024×7682048×15363312×2480
3:4768×10241536×20482480×3312
5:41280×1024 / 1448×10862560×20483216×2576
4:51024×1280 / 1122×14022048×25602576×3216
16:91536×864 / 1672×9412048×11523840×2160
9:16864×1536 / 941×16721152×20482160×3840
2:12048×1024 / 1774×8872688×13443840×1920
1:21024×2048 / 887×17741344×26881920×3840
3:11881×836 / 1536×5123072×10243840×1280
1:3887×1774 / 512×15361024×30721280×3840
21:92016×864 / 1915×8212688×11523840×1648
9:21864×2016 / 821×19151152×26881648×3840
La 4K prend en charge les 15 ratios listés ci-dessus ; vous pouvez également transmettre les dimensions en pixels du tableau directement via size.
image_urls
array
Tableau d’images de référence (champ standard OpenAI). Passe en mode image-vers-image lorsqu’il est fourni.
Les autres champs standard OpenAI (response_format, quality, style) ne sont pas pris en charge et seront ignorés. Les résultats des tâches ne renvoient que url — veuillez télécharger et convertir en base64 vous-même si nécessaire.
official_fallback
boolean
défaut:"false"
Faut-il basculer vers le canal officiel
  • false : Ne pas utiliser (par défaut)
  • true : Utiliser le canal officiel

Exemples d’utilisation

Texte-vers-image (requête minimale)
{
  "model": "gpt-image-2",
  "prompt": "A ginger cat sitting on a windowsill watching the sunset, watercolor style"
}
Texte-vers-image (avec ratio + 2K)
{
  "model": "gpt-image-2",
  "prompt": "a corgi astronaut on the moon, cinematic, 8k",
  "size": "16:9",
  "resolution": "2k"
}
Texte-vers-image (sortie 4K)
{
  "model": "gpt-image-2",
  "prompt": "An ancient castle under a starry sky",
  "size": "16:9",
  "resolution": "4k"
}
Image-vers-image (référence = URL)
{
  "model": "gpt-image-2",
  "prompt": "Turn this photo into a watercolor painting",
  "image_urls": [
    "https://example.com/photo.jpg"
  ]
}
Image-vers-image (référence = base64)
{
  "model": "gpt-image-2",
  "prompt": "Turn this photo into a watercolor painting",
  "image_urls": [
    "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  ]
}
Image-vers-image (fusion multi-références, URL + base64 mélangés)
{
  "model": "gpt-image-2",
  "prompt": "Fuse these two photos into a single poster",
  "size": "4:3",
  "resolution": "2k",
  "image_urls": [
    "https://example.com/photo-a.jpg",
    "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  ]
}

Response

code
integer
Code de statut de la réponse
data
array
Tableau de données de réponse

Interrogation des résultats de tâche

Après une soumission réussie, un task_id est renvoyé. Interrogez l’état de la tâche via GET /v1/tasks/{task_id}, voir API d’interrogation des tâches pour plus de détails.

Exemple de réponse en cas de succès

{
  "code": 200,
  "data": {
    "id": "task_01KPQ7J7DWB7QZ3WCEK3YVPBRA",
    "status": "completed",
    "progress": 100,
    "created": 1776748674,
    "completed": 1776748726,
    "actual_time": 52,
    "cost": 0.05279,
    "estimated_time": 100,
    "result": {
      "images": [
        {
          "url": [
            "https://upload.apimart.ai/f/image/xxxxxxxx-gpt_image_2_task_xxx_0.png"
          ],
          "expires_at": 1776835126
        }
      ]
    }
  }
}
Accès à l’image : data.result.images[0].url[0]

Statuts de tâche

StatutSignification
submittedSoumise
processingEn cours de traitement en amont
completedSuccès, result.images disponible
failedÉchec, voir error.message

Recommandations pour l’interrogation

  • Délai avant la première requête : Attendez 10 à 20 secondes après soumission avant la première requête
  • Intervalle d’interrogation : 3 à 5 secondes recommandées, évitez l’interrogation à la milliseconde
  • Référence de délai d’expiration : Une image unique se termine généralement en 30 à 60 secondes (actual_time observé de 44 à 53 s)
  • Requête par lot : Pour interroger plusieurs tâches à la fois, utilisez POST /v1/tasks/batch avec le corps {"task_ids": ["task_xxx", "task_yyy"]}

Notes

  1. Traitement asynchrone : La soumission renvoie task_id, interrogez /v1/tasks/{task_id} pour obtenir l’URL finale de l’image
  2. Modération de contenu : Le prompt est d’abord examiné — les violations sont rejetées sans facturation
  3. URL du résultat : La plateforme reflète les liens signés temporaires en amont dans son propre stockage objet R2, renvoyant un lien stable auquel les clients peuvent accéder directement
  4. Validité de l’URL : expires_at = completed + 24h dans la réponse est un champ indicatif, veuillez télécharger ou refléter rapidement vers votre propre CDN
  5. Conflit de ratio : Utilisez le champ size pour le ratio d’aspect — évitez de le répéter dans le prompt pour prévenir toute ambiguïté en amont
  6. Facturation : Facturé par niveau de résolution (1K / 2K / 4K), aucun frais en cas d’échec ou de rejet par la modération
  7. Ratios pris en charge en 4K : Les 15 ratios ci-dessus prennent tous en charge la 4K ; vous pouvez également transmettre les dimensions en pixels correspondantes directement via size
  8. Rétention des tâches : Le task_id est conservé dans la base de données par défaut pendant plusieurs jours (configuré par TASK_RETENTION_DAYS) — les requêtes expirées renvoient « la tâche n’existe pas ou a expiré »