Zum Hauptinhalt springen
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-official",
    "prompt": "An ancient castle beneath a starry sky",
    "size": "16:9",
    "resolution": "2k",
    "quality": "high",
    "n": 1
  }'
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KPTXXXXXXXXXXXXXXX"
    }
  ]
}

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-official",
    "prompt": "An ancient castle beneath a starry sky",
    "size": "16:9",
    "resolution": "2k",
    "quality": "high",
    "n": 1
  }'
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KPTXXXXXXXXXXXXXXX"
    }
  ]
}

Autorisierung

Authorization
string
erforderlich
Alle Endpunkte erfordern eine Authentifizierung per Bearer TokenAPI-Schlüssel erhalten:Besuchen Sie die Seite zur Verwaltung von API-Schlüsseln, um Ihren API-Schlüssel zu erhaltenFügen Sie ihn in den Anfrage-Header ein:
Authorization: Bearer YOUR_API_KEY

Body

model
string
Standard:"gpt-image-2-official"
erforderlich
Name des BildgenerierungsmodellsFest auf gpt-image-2-official (offizielles OpenAI-Modell gpt-image-2) gesetzt
prompt
string
erforderlich
Textbeschreibung für die Bildgenerierung
  • Unterstützt Englisch und Chinesisch, detaillierte Beschreibungen werden empfohlen
  • Inhaltsmoderation / Sicherheitsprüfung vor dem Einreichen — Verstöße werden sofort abgelehnt
size
string
Standard:"1:1"
Seitenverhältnis des BildesExtern werden Verhältniswerte verwendet; intern werden sie gemäß resolution automatisch auf tatsächliche Pixel abgebildet.Unterstützte Seitenverhältnisse, plus auto, damit der Server automatisch ein passendes Verhältnis auswählt:
  • auto – Automatisch (Server wählt ein Verhältnis basierend auf Prompt / Referenzbildern)
  • 1:1 – Quadrat (Standard, Social-Avatare / Logos)
  • 3:2 – Querformat (gängiges DSLR-Verhältnis)
  • 2:3 – Hochformat (vertikale Poster)
  • 4:3 – Querformat (klassischer Monitor / Diashow)
  • 3:4 – Hochformat
  • 5:4 – Querformat
  • 4:5 – Hochformat (Instagram-Hochformat-Post)
  • 16:9 – Querformat (Breitbild-Video-Thumbnail)
  • 9:16 – Hochformat (Telefon-Vollbild / Short-Video-Cover)
  • 2:1 – Querformat (Web-Banner)
  • 1:2 – Hochformat
  • 3:1 – Querformat (ultrabreiter Banner)
  • 1:3 – Hochformat (extra hohes Poster)
  • 21:9 – Querformat (Kinoformat ultrabreit)
  • 9:21 – Hochformat
Pixelabmessungen können auch direkt übergeben werden, z. B. 1881x836 / 887x1774.
Wenn size auf auto gesetzt ist, beträgt das Standardverhältnis 1:1.
resolution
string
Standard:"1k"
Auflösungsstufe (neues Feld)Steuert die tatsächliche Ausgabeschärfe.
  • 1k – Basis 1024, kosteneffizient für den täglichen Einsatz (Standard)
  • 2k – Basis 2048, geeignet für Poster / Anforderungen an hohe Auflösung
  • 4k – Basis 3840, unterstützt die 15 Verhältnisse in der Zuordnungstabelle unten
4K unterstützt die 15 Verhältnisse in der Zuordnungstabelle unten; Sie können die Pixelabmessungen aus der Tabelle auch direkt über size übergeben.
quality
string
Standard:"auto"
Bildqualität
  • auto – Automatisch (Standard, typischerweise gleichwertig mit low)
  • low – Schnell und sparsam, ausreichend für grobe Umrisse
  • medium – Ausgewogen
  • high – Höchste Präzision (4K + high kann über 120 s dauern)
background
string
Standard:"auto"
Hintergrundmodus
  • auto – Automatisch (Standard)
  • opaque – Undurchsichtig
  • transparent – ⚠️ gpt-image-2-official unterstützt keine transparenten Hintergründe; das System stuft stillschweigend auf auto herab
moderation
string
Standard:"auto"
Moderationsstärke
  • auto – Standard-Moderationsstärke
  • low – Mildere Moderation
output_format
string
Standard:"png"
Ausgabeformat
  • png – Standard
  • jpeg – Kleinere Dateien
  • webp – Optimal für moderne Browser
output_compression
integer
Ausgabe-Kompressionsstufe, Bereich 0–100
  • Nur für jpeg / webp wirksam
n
integer
Standard:"1"
Anzahl der zu generierenden BilderBereich: 1 ~ 4
Muss eine reine Zahl sein (z. B. 1), nicht in Anführungszeichen setzen
image_urls
array
Array mit Referenzbild-URLs
mask_url
string
Masken-Bild-URL, für Inpainting verwendet
  • Muss zusammen mit image_urls verwendet werden
  1. Stellen Sie vor dem Hochladen sicher, dass das Maskenbild einen Alphakanal besitzt.
  2. Die Abmessungen des Maskenbildes müssen mit dem ersten Referenzbild übereinstimmen.

Size × Resolution Zuordnung

size × resolution → tatsächliche OpenAI-Pixel (15 Verhältnisse × 3 Stufen):
size1k2k4k
1:11024×10242048×20482880×2880
3:21536×10242048×13603520×2336
2:31024×15361360×20482336×3520
4:31024×7682048×15363312×2480
3:4768×10241536×20482480×3312
5:41280×10242560×20483216×2576
4:51024×12802048×25602576×3216
16:91536×8642048×11523840×2160
9:16864×15361152×20482160×3840
2:12048×10242688×13443840×1920
1:21024×20481344×26881920×3840
3:11881×836 / 1536×5123072×10243840×1280
1:3887×1774 / 512×15361024×30721280×3840
21:92016×8642688×11523840×1648
9:21864×20161152×26881648×3840
Hinweis: Einige Abmessungen sind auf Vielfache von 16 und Pixelgrenzen angenähert, z. B. 3:2 / 2:3 @ 2K mit 2048×1360 und 21:9 @ 4K mit 3840×1648. Als verbindliche Quelle gelten die tatsächlichen Pixel in der Tabelle.

Anwendungsbeispiele

Text-zu-Bild (minimale Anfrage)
{
  "model": "gpt-image-2-official",
  "prompt": "An ancient castle beneath a starry sky"
}
2K-Hochauflösungsposter
{
  "model": "gpt-image-2-official",
  "prompt": "Cyberpunk night scene",
  "size": "16:9",
  "resolution": "2k",
  "quality": "high",
  "output_format": "jpeg",
  "output_compression": 90
}
4K-Hintergrundbild
{
  "model": "gpt-image-2-official",
  "prompt": "Snow mountain sunrise panorama",
  "size": "16:9",
  "resolution": "4k",
  "quality": "high",
  "n": 1
}
Bild-zu-Bild (Mehrfachreferenz-Fusion)
{
  "model": "gpt-image-2-official",
  "prompt": "Fuse the two reference images into a single illustration poster, preserving the main silhouettes",
  "size": "1:1",
  "quality": "high",
  "image_urls": [
    "https://your-cdn.com/input-a.png",
    "https://your-cdn.com/input-b.png"
  ]
}
Inpainting (Maske)
{
  "model": "gpt-image-2-official",
  "prompt": "Replace the background with a desert sunset",
  "size": "1:1",
  "quality": "medium",
  "image_urls": ["https://your-cdn.com/photo.png"],
  "mask_url": "https://your-cdn.com/mask.png"
}
Mehrere Bilder (n > 1)
{
  "model": "gpt-image-2-official",
  "prompt": "Four minimalist poster variations of a red fox",
  "size": "1:1",
  "quality": "low",
  "n": 4
}
Direkte Pixel-Zeichenkette (fortgeschritten)
{
  "model": "gpt-image-2-official",
  "prompt": "wide cinematic shot",
  "size": "3840x2160",
  "quality": "high"
}

Response

code
integer
Statuscode der Antwort
data
array
Array mit Antwortdaten

Abfrage der Aufgabenergebnisse

Nach erfolgreicher Einreichung wird eine task_id zurückgegeben. Pollen Sie den Aufgabenstatus über GET /v1/tasks/{task_id}, siehe API zur Aufgabenabfrage für Details.

Beispiel einer erfolgreichen Antwort

{
  "code": 200,
  "data": {
    "id": "task_01KPTXXXXXXXXXXXXXXX",
    "status": "completed",
    "progress": 100,
    "actual_time": 46,
    "cost": 0.05279,
    "result": {
      "images": [
        {
          "url": [
            "https://upload.apimart.ai/f/image/xxxxxxxx-gpt_image_2_official_task_xxx_0.png"
          ],
          "expires_at": 1776928569
        }
      ]
    }
  }
}
Aufgabenstatusverlauf: submittedin_progresscompleted / failed. Bildzugriff: data.result.images[0].url[0].

Empfehlungen zum Polling

  • Verzögerung der ersten Abfrage: Warten Sie nach dem Einreichen 10–20 Sekunden bis zur ersten Abfrage
  • Abfrageintervall: Empfohlen werden 3–5 Sekunden
  • Timeout-Referenz: Kombinationen aus high + 2k/4k können bis zu 130 Sekunden dauern; ein Client-Timeout von ≥ 180 Sekunden wird empfohlen
  • Sammelabfrage: Verwenden Sie zum gleichzeitigen Abfragen mehrerer Aufgaben POST /v1/tasks/batch