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",
    "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"
    }
  ]
}

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"
erforderlich
Name des BildgenerierungsmodellsFest auf 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
n
integer
Standard:"1"
Anzahl der zu generierenden BilderBereich: 1
Muss eine reine Zahl sein (z. B. 1), nicht in Anführungszeichen setzen
size
string
Standard:"1:1"
Seitenverhältnis des BildesUnterstützte Seitenverhältnisse, plus auto, damit der Server automatisch ein passendes Verhältnis auswählt:
sizeTyp
autoAutomatisch
1:1Quadrat
3:2Querformat
2:3Hochformat
4:3Querformat
3:4Hochformat
5:4Querformat
4:5Hochformat
16:9Querformat
9:16Hochformat
2:1Querformat
1:2Hochformat
3:1Querformat
1:3Hochformat
21:9Querformat
9:21Hochformat
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"
AusgabeauflösungsstufeOptionen: 1k / 2k / 4ksize × resolution → tatsächliche Pixelzuordnung:
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
4K unterstützt die oben aufgeführten 15 Seitenverhältnisse; Sie können die Pixelabmessungen aus der Tabelle auch direkt über size übergeben.
image_urls
array
Array von Referenzbildern (OpenAI-Standardfeld). Wechselt bei Angabe in den Bild-zu-Bild-Modus.
Andere OpenAI-Standardfelder (response_format, quality, style) werden nicht unterstützt und ignoriert. Aufgabenergebnisse geben nur url zurück — bitte laden Sie das Bild bei Bedarf selbst herunter und konvertieren Sie es in Base64.
official_fallback
boolean
Standard:"false"
Ob auf den offiziellen Kanal zurückgegriffen werden soll
  • false: Nicht verwenden (Standard)
  • true: Offiziellen Kanal verwenden

Anwendungsbeispiele

Text-zu-Bild (minimale Anfrage)
{
  "model": "gpt-image-2",
  "prompt": "A ginger cat sitting on a windowsill watching the sunset, watercolor style"
}
Text-zu-Bild (mit Seitenverhältnis + 2K)
{
  "model": "gpt-image-2",
  "prompt": "a corgi astronaut on the moon, cinematic, 8k",
  "size": "16:9",
  "resolution": "2k"
}
Text-zu-Bild (4K-Ausgabe)
{
  "model": "gpt-image-2",
  "prompt": "An ancient castle under a starry sky",
  "size": "16:9",
  "resolution": "4k"
}
Bild-zu-Bild (Referenz = URL)
{
  "model": "gpt-image-2",
  "prompt": "Turn this photo into a watercolor painting",
  "image_urls": [
    "https://example.com/photo.jpg"
  ]
}
Bild-zu-Bild (Referenz = Base64)
{
  "model": "gpt-image-2",
  "prompt": "Turn this photo into a watercolor painting",
  "image_urls": [
    "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  ]
}
Bild-zu-Bild (Mehrfachreferenz-Fusion, URL + Base64 gemischt)
{
  "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
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_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
        }
      ]
    }
  }
}
Bildzugriff: data.result.images[0].url[0]

Aufgabenstatus

StatusBedeutung
submittedEingereicht
processingWird vorgelagert verarbeitet
completedErfolg, result.images verfügbar
failedFehlgeschlagen, siehe error.message

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, vermeiden Sie Millisekunden-Polling
  • Timeout-Referenz: Ein einzelnes Bild ist typischerweise in 30–60 Sekunden fertig (beobachtete actual_time 44–53 s)
  • Sammelabfrage: Verwenden Sie zum gleichzeitigen Abfragen mehrerer Aufgaben POST /v1/tasks/batch mit dem Body {"task_ids": ["task_xxx", "task_yyy"]}

Hinweise

  1. Asynchrone Verarbeitung: Beim Einreichen wird task_id zurückgegeben, pollen Sie /v1/tasks/{task_id}, um die endgültige Bild-URL zu erhalten
  2. Inhaltsmoderation: Der prompt wird zuerst geprüft — Verstöße werden ohne Abrechnung abgelehnt
  3. Ergebnis-URL: Die Plattform spiegelt vorgelagerte temporäre signierte Links in ihren eigenen R2-Objektspeicher und gibt einen stabilen Link zurück, auf den Clients direkt zugreifen können
  4. URL-Gültigkeit: expires_at = completed + 24h in der Antwort ist ein Hinweisfeld; bitte zeitnah herunterladen oder auf Ihr eigenes CDN spiegeln
  5. Seitenverhältnis-Konflikt: Verwenden Sie das Feld size für das Seitenverhältnis — vermeiden Sie es, dies im prompt zu wiederholen, um vorgelagerte Mehrdeutigkeiten zu vermeiden
  6. Abrechnung: Abrechnung nach Auflösungsstufe (1K / 2K / 4K), keine Abrechnung bei Fehler oder Ablehnung durch Moderation
  7. Für 4K unterstützte Seitenverhältnisse: Alle 15 Verhältnisse oben unterstützen 4K; Sie können die entsprechenden Pixelabmessungen auch direkt über size übergeben
  8. Aufgaben-Aufbewahrung: task_id wird standardmäßig mehrere Tage in der Datenbank aufbewahrt (konfiguriert über TASK_RETENTION_DAYS) — abgelaufene Abfragen geben „Aufgabe existiert nicht oder ist abgelaufen” zurück