Ideogram V3 Character

API kılavuzu ve entegrasyon referansı: uç nokta, girdi alanları, fiyatlar, webhook ve hatalar.

Mod

Bu modelin 3 modu var; alanlar, çıktı ve fiyatlar seçili moda göredir. Modu istekte category_id ile seçin (örneklerde hazır). Göndermezseniz girdinize uyan mod, o da yoksa varsayılan mod çalışır.

İstek ve yanıt

POST

https://kolayzeka.com/api/models/ideogram-v3-character/generate

Gövde: { "input": {…alanlar}, "category_id"?: sayı, "webhook_url"?: "https://…" }. Alanlar aşağıda; tanımlı olmayan bir alan 422 döner.

cURL · JSON

curl -X POST https://kolayzeka.com/api/models/ideogram-v3-character/generate \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "rendering_speed": "BALANCED",
    "expand_prompt": true,
    "num_images": 1,
    "prompt": "Prompt",
    "image_url": "https://cdn.example.com/input.jpg",
    "mask_url": "Mask URL",
    "reference_image_urls": [
      "https://cdn.example.com/input-1.jpg"
    ]
  },
  "category_id": 6,
  "webhook_url": "https://your-server.com/hooks/kolayzeka"
}'

cURL · multipart (dosya yükleyerek)

curl -X POST https://kolayzeka.com/api/models/ideogram-v3-character/generate \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F 'input[rendering_speed]=BALANCED' \
  -F 'input[expand_prompt]=true' \
  -F 'input[num_images]=1' \
  -F 'input[prompt]=Prompt' \
  -F 'input[mask_url]=Mask URL' \
  -F 'input[image_urls][]=@./image_urls-1.jpg' \
  -F 'input[image_url]=@./image_url.jpg' \
  -F 'input[reference_image_urls][]=@./reference_image_urls-1.jpg' \
  -F 'category_id=6' \
  -F 'webhook_url=https://your-server.com/hooks/kolayzeka'

Üretim asenkrondur. POST, 202 ve status: "queued" döner; sonuç henüz yoktur. Sonucu GET https://kolayzeka.com/api/generations/{id} ile sorgulayın ya da webhook_url verin (aynı nesne gelir). Durumlar: queued → processing → completed | failed. estimated_seconds bu modun geçmiş ortalama süresidir (null olabilir).

1 · POST yanıtı (202)

{
  "data": {
    "id": "9d1c…-uuid",
    "model": "ideogram-v3-character",
    "output_type": "image",
    "source": "api",
    "status": "queued",
    "input_data": {
      "rendering_speed": "BALANCED",
      "expand_prompt": true,
      "num_images": 1,
      "prompt": "Prompt",
      "image_url": "https://cdn.example.com/input.jpg",
      "mask_url": "Mask URL",
      "reference_image_urls": [
        "https://cdn.example.com/input-1.jpg"
      ]
    },
    "output_data": null,
    "thumbnail_url": null,
    "credit_cost": 44811,
    "duration": null,
    "estimated_seconds": 12,
    "error_message": null,
    "webhook_url": "https://your-server.com/hooks/kolayzeka",
    "created_at": "2026-06-29T12:00:00.000000Z",
    "updated_at": "2026-06-29T12:00:00.000000Z"
  },
  "success": true
}

2 · Tamamlandı (GET /generations/{id} veya webhook)

{
  "data": {
    "id": "9d1c…-uuid",
    "model": "ideogram-v3-character",
    "output_type": "image",
    "source": "api",
    "status": "completed",
    "input_data": {
      "rendering_speed": "BALANCED",
      "expand_prompt": true,
      "num_images": 1,
      "prompt": "Prompt",
      "image_url": "https://cdn.example.com/input.jpg",
      "mask_url": "Mask URL",
      "reference_image_urls": [
        "https://cdn.example.com/input-1.jpg"
      ]
    },
    "output_data": {
      "result": "https://<signed-url>/output.jpg"
    },
    "thumbnail_url": "https://<signed-url>/thumb.jpg",
    "credit_cost": 44811,
    "duration": 4.52,
    "estimated_seconds": 12,
    "error_message": null,
    "webhook_url": "https://your-server.com/hooks/kolayzeka",
    "created_at": "2026-06-29T12:00:00.000000Z",
    "updated_at": "2026-06-29T12:00:05.000000Z"
  },
  "success": true
}

3 · Başarısız

{
  "data": {
    "id": "9d1c…-uuid",
    "model": "ideogram-v3-character",
    "output_type": "image",
    "source": "api",
    "status": "failed",
    "input_data": {
      "rendering_speed": "BALANCED",
      "expand_prompt": true,
      "num_images": 1,
      "prompt": "Prompt",
      "image_url": "https://cdn.example.com/input.jpg",
      "mask_url": "Mask URL",
      "reference_image_urls": [
        "https://cdn.example.com/input-1.jpg"
      ]
    },
    "output_data": null,
    "thumbnail_url": null,
    "credit_cost": 0,
    "duration": null,
    "estimated_seconds": 12,
    "error_message": "Sağlayıcı yoğun, lütfen tekrar deneyin.",
    "webhook_url": "https://your-server.com/hooks/kolayzeka",
    "created_at": "2026-06-29T12:00:00.000000Z",
    "updated_at": "2026-06-29T12:00:00.000000Z"
  },
  "success": true
}

Sonuç output_data.result alanındadır (imzalı URL, süreli: kalıcı tutmak için kendi depolamanıza indirin).
Medya URL'leri imzalıdır ve süresi dolar; eski bir URL için işi tekrar GET edin, taze URL gelir.
Geçmiş: GET https://kolayzeka.com/api/generations (en yeni önce, sayfa başına 20, ?page=).

Fiyat ve teklif

Fiyat kredi cinsindendir ve seçtiğiniz seçeneklere (kalite, boyut, süre, adet…) göre değişir. Varsayılan ayarlarla bu mod ≈ 44811 kredi.

POST

https://kolayzeka.com/api/models/ideogram-v3-character/quote

Çalıştırmadan, tam bu girdinin fiyatı. Token gerekmez; girdiyi üretimdeki gibi doğrular.

cURL

curl -X POST https://kolayzeka.com/api/models/ideogram-v3-character/quote \
  -H "Content-Type: application/json" \
  -d '{"input":{"rendering_speed":"BALANCED","expand_prompt":true,"num_images":1,"prompt":"Prompt","image_url":"https://cdn.example.com/input.jpg","mask_url":"Mask URL","reference_image_urls":["https://cdn.example.com/input-1.jpg"]},"category_id":6}'

Yanıt

{
  "success": true,
  "data": {
    "credits": 44811,
    "basis": "per_image",
    "exact": true,
    "mode": {
      "category_id": 6,
      "label": "Image to Image"
    }
  }
}

exact: false: fiyat çıktıya bağlı (ör. token, gerçek süre); teklif tipik değerle hesaplanır.
Kredi, istek kabul edilince teklif tutarı kadar ayrılır. İş bitince gerçek tutara göre fark düşülür ya da iade edilir; iş başarısız olursa tamamı iade edilir. Kesin tutar: sonuçtaki credit_cost.
Bakiye: GET https://kolayzeka.com/api/me → credit_balance. Yetmezse 402 insufficient_credits.

Girdi alanları

input içine gönderilir. Tip etiketi gönderilecek JSON değeridir (string, integer, number, boolean, url, array<url>). Aynı liste makine-okunur olarak GET https://kolayzeka.com/api/ai-models/ideogram-v3-character yanıtında.

image_urls

isteğe bağlı

array<url>

dosya

Image Urls · A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format

JSON'da herkese açık bir https URL listesi gönderin, ya da dosyayı multipart ile yükleyin: -F 'input[image_urls][]=@./dosya.jpg'

rendering_speed

isteğe bağlı

string

Rendering Speed · The rendering speed to use.

Kabul edilen değerler:"TURBO""BALANCED""QUALITY"

Varsayılan: "BALANCED" (gönderilmezse bu kullanılır)

color_palette

isteğe bağlı

string

Color palette · A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members)

style_codes

isteğe bağlı

string

Style Codes · A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style

expand_prompt

isteğe bağlı

boolean

Expand Prompt · Determine if MagicPrompt should be used in generating the request or not.

Varsayılan: true (gönderilmezse bu kullanılır)

num_images

isteğe bağlı

number

Num Images · Number of images to generate.

Varsayılan: 1 (gönderilmezse bu kullanılır)

Sınırlar: en az 1 · en çok 8

seed

isteğe bağlı

number

Seed · Seed for the random number generator

prompt

zorunlu

string

Prompt · The prompt to fill the masked part of the image.

image_url

zorunlu

url

dosya

Image URL · The image URL to generate an image from. MUST have the exact same dimensions (width and height) as the mask image.

JSON'da herkese açık bir https URL gönderin, ya da dosyayı multipart ile yükleyin: -F 'input[image_url]=@./dosya.jpg'

mask_url

zorunlu

string

Mask URL · The mask URL to inpaint the image. MUST have the exact same dimensions (width and height) as the input image.

reference_image_urls

zorunlu

array<url>

dosya

Reference Image Urls · A set of images to use as character references. Currently only 1 image is supported, rest will be ignored. (maximum total size 10MB across all character references). The images should be in JPEG, PNG or WebP format

JSON'da herkese açık bir https URL listesi gönderin, ya da dosyayı multipart ile yükleyin: -F 'input[reference_image_urls][]=@./dosya.jpg'

reference_mask_urls

isteğe bağlı

string

Reference Mask Urls · A set of masks to apply to the character references. Currently only 1 mask is supported, rest will be ignored. (maximum total size 10MB across all character references). The masks should be in JPEG, PNG or WebP format

Kimlik doğrulama

Her istekte Authorization: Bearer YOUR_API_TOKEN. Token'ı Profil sayfasında oluşturun. Katalog ve teklif (/ai-models, /quote) token istemez. Ayrıntılar: geliştirici rehberi.

Webhook

İsteğe bir webhook_url (https) ekleyin; iş bitince oraya imzalı bir POST gelir. Gövde { event, success, data }: data, durum endpoint'inin döndüğü nesnenin aynısıdır. Sorgulamaya gerek kalmaz; uzun işler (video, çok adımlı uygulamalar) için önerilir.

Gelen başlıklar

X-KolayZeka-Event: generation.completed // veya generation.failed

X-KolayZeka-Signature: sha256=<hex>

User-Agent: KolayZeka-Webhook/1.0

İmza = ham gövdenin, hesabınızın webhook imzalama anahtarı ile HMAC-SHA256'sı. Anahtarı Profil sayfasında oluşturun (bir kez gösterilir). Anahtar yoksa webhook gönderilmez.

Doğrulama · Node.js

import crypto from 'node:crypto';

// rawBody: the request body exactly as received (before JSON.parse).
const expected = 'sha256=' + crypto
  .createHmac('sha256', process.env.KOLAYZEKA_WEBHOOK_SECRET)
  .update(rawBody)
  .digest('hex');
const given = req.headers['x-kolayzeka-signature'] ?? '';

if (given.length !== expected.length ||
    !crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(given))) {
  return res.status(401).end();
}

Doğrulama · PHP / Laravel

$expected = 'sha256='.hash_hmac('sha256', $request->getContent(), config('services.kolayzeka.webhook_secret'));

abort_unless(hash_equals($expected, (string) $request->header('X-KolayZeka-Signature')), 401);

2xx dönün. Diğer yanıtlar ve ağ hataları 30 sn arayla en çok 5 kez yeniden denenir.
Aynı iş için birden fazla gelebilir: data.id ile tekilleştirin.
Özel / iç ağ / bulut-metadata adresleri reddedilir (422 invalid_webhook_url).

Hatalar

Her hata aynı şekildedir: { success: false, code, error, … }. Kodunuzu code'a göre yazın; error insan için mesajdır.

HTTP	code	Ne zaman
400	invalid_mode	Modelin şu an çalıştırılabilir bir modu yok (geçici; başka model deneyin).
401	unauthenticated	Bearer token yok, geçersiz ya da iptal edilmiş.
402	insufficient_credits	Bakiye yetmiyor. Yanıtta balance (bakiye) ve required (gereken) var.
403	forbidden	Bu kaynağa erişim yetkiniz yok.
404	not_found	Model / uygulama / iş yok, aktif değil ya da size ait değil.
405	method_not_allowed	Endpoint bu HTTP metodunu kabul etmiyor.
422	validation_failed	Girdi şemaya uymuyor. errors alanı: alan → mesajlar.
422	invalid_webhook_url	webhook_url https değil, çözümlenmiyor ya da özel / iç ağ adresi.
429	rate_limited	Hız sınırı aşıldı. retry_after saniye sonra tekrar deneyin.
500	server_error	Beklenmeyen hata. Tekrar denemeden önce listeden (GET /api/generations) işin oluşup oluşmadığına bakın.

402 örneği

{
  "success": false,
  "code": "insufficient_credits",
  "error": "Yetersiz kredi. Bakiye: 40, Gerekli: 55",
  "balance": 40,
  "required": 55
}

422 örneği

{
  "success": false,
  "code": "validation_failed",
  "error": "Doğrulama başarısız oldu.",
  "errors": {
    "quality": [
      "`quality` alanı şunlardan biri olmalıdır: low, medium, high."
    ]
  }
}

Ideogram V3 Character modeline geri dön