API Hop

Belgeler

API Hop Belgeleri

OpenAI çok modlu yanıtları

OpenAI uyumlu Responses API. Bu uç nokta OpenAI tarzı `input` kullanır; metin, herkese açık görsel URL’leri, PDF dosya girdisi, araç çağrıları, akıl yürütme seçenekleri ve akış parametrelerini destekler.

POSThttps://api.apihop.ai/openai/responses

OpenAI uyumlu Responses API. Bu uç nokta OpenAI tarzı input kullanır; metin, herkese açık görsel URL’leri, PDF dosya girdisi, araç çağrıları, akıl yürütme seçenekleri ve akış parametrelerini destekler.

text
POST https://api.apihop.ai/openai/responses

Kimlik doğrulama

Tüm istekler Bearer belirteciyle kimlik doğrulama gerektirir.

http
Authorization: Bearer YOUR_API_KEY

İstek gövdesi

modelstringzorunluVarsayılan: gpt-5.4

Responses destekleyen mevcut etkin modeller:

  • gpt-5.4
  • gpt-5.5
  • gpt-5.6-sol
  • gpt-5.6-terra
  • gpt-6-astra

Geçerli API anahtarının görebildiği modeller için Model kataloğuna bakın.

inputstring | object[]

Girdi içeriği. Boş olmayan previous_response_id sağlanmadıkça zorunludur. İki alanı da atlamak veya geçersiz girdi türü kullanmak faturalandırmadan önce 400 döndürür.

Desteklenen biçimler:

  • Tek bir user metin girdisine eşdeğer dize.
  • Konuşma geçmişi, çok modlu girdi ve araç çağrısı sonuçları için girdi öğeleri dizisi.

Girdi dizisindeki her nesne şu alanları içerebilir:

typestring

Girdi öğesi türü.

Yaygın değerler:

  • message: mesaj girdisi.
  • function_call_output: işlev aracı çağrısının sonucu.
rolestring

type=message olduğunda rol.

Yaygın değerler:

  • developer
  • system
  • user
  • assistant
contentstring | object[]

Mesaj içeriği.

Çok modlu isteklerde içerik blokları dizisi kullanın. İçerik blokları şunları destekler:

typestring

İçerik bloğu türü.

Şu anda desteklenenler:

  • input_text
  • input_image
  • input_file
textstring

type=input_text olduğunda metin içeriği.

image_urlstring

type=input_image olduğunda herkese açık görsel URL’si.

Yalnızca herkese açık http:// veya https:// görsel URL’leri desteklenir. data:image/...;base64,... gibi Base64 veri URL’leri desteklenmez.

detailstringVarsayılan: auto

type=input_image olduğunda görsel ayrıntı düzeyi.

Yaygın değerler:

  • auto
  • low
  • high
file_datastring

type=input_file olduğunda dosya içeriğinin veri URL’si. PDF’ler data:application/pdf;base64,... kullanabilir.

filenamestring

type=input_file olduğunda dosya adı.

instructionsstring

Model bağlamına eklenen sistem veya geliştirici talimatları.

max_output_tokensinteger

Pozitif tam sayı olarak isteğe bağlı azami çıktı tokenı. Seçilen modelin üst sağlayıcı varsayılanı için alanı atlayın. Modele bağlı olarak bütçe akıl yürütme tokenlarını ve nihai metni kapsayabilir. Küçük bütçe yanıtı kesebilir veya nihai metinden önce tükenebilir; artırmak maliyeti artırabilir.

streambooleanVarsayılan: false

Yanıtın akış halinde döndürülüp döndürülmeyeceği.

  • false: tek bir tam yanıt döndürür
  • true: OpenAI Responses tarzı SSE olayları döndürür
temperaturenumberVarsayılan: 1.0

Örnekleme sıcaklığı, genellikle 0 ile 2 arasında.

top_pnumberVarsayılan: 1.0

Çekirdek örnekleme parametresi, genellikle 0 ile 1 arasında.

textobject

Metin çıktısı yapılandırması.

text.formatobject

{ "type": "text" } veya JSON şeması gibi metin biçimi yapılandırması.

text.verbositystring

low, medium veya high gibi çıktı ayrıntı düzeyi. Destek seçilen modele bağlıdır.

toolsobject[]

Araç tanımları. Kullanılabilirlik seçilen modele ve mevcut özelliklere bağlıdır.

tool_choicestring | object

Araç seçimi ilkesi.

parallel_tool_callsboolean

Paralel araç çağrılarına izin verilip verilmediği.

reasoningobject

Akıl yürütmeyle ilgili seçenekler.

includestring[]

Yanıta dahil edilecek ek alanlar.

prompt_cache_keystring

İstem önbelleğini yeniden kullanmak için önbellek anahtarı.

prompt_cache_retentionstring

İstem önbelleği saklama ilkesi. Desteklenen değerler seçilen modele ve mevcut özelliklere bağlıdır.

safety_identifierstring

Güvenlik kontrolleri için kararlı son kullanıcı kimliği.

storeboolean

Yanıt durumunun saklanıp saklanamayacağı.

Model parametresi farkları

  • Yerel OpenAI uyumlu Responses iletimi, üst sağlayıcı isteğinde top_p korur; doğrulama ve örnekleme davranışı seçilen modele ve üst sağlayıcıya bağlıdır. 2026-09-26 kontrolleri gpt-5.5, gpt-5.6-sol ve gpt-5.6-terra için top_p: 0.9 kabul etti. Kabul ve iletim, örnekleme etkisini kanıtlamaz veya diğer değerler, modeller ya da sonraki istekler için desteği garanti etmez. Asgari istekle başlayın.
  • Bu sayfadaki destek yalnızca normal /openai/responses uç noktasına uygulanır. Aynı modelin /openai/responses/compact, WebSocket veya durum tutan previous_response_id desteklediği anlamına gelmez.
  • Yukarıdaki beş GPT modelinin şu anda doğrulanmış Compact kanalı yoktur. Açıkça etkinleştirilmiş kanal bulunmadığında Compact istekleri faturalandırmadan önce reddedilir. Normal Responses ve Responses WebSocket kullanılabilir olmaya devam eder.

İstek örnekleri

Aşağıdaki örnekler input sağlar. Devam isteği geçerli previous_response_id sağlıyor ve seçilen kanal durumlu devamı destekliyorsa input atlanabilir. Yanıt kimliği, desteklenmeyen kanalda bu yeteneği etkinleştirmez. function_call_output dahil araç sonuçları geçerli girdi öğeleridir.

Metin

json
{
  "model": "gpt-5.4",
  "input": "Hello, introduce yourself in one sentence."
}

Codex CLI tarzı parametreler

json
{
  "model": "gpt-5.5",
  "input": "Reply with READY only.",
  "reasoning": {
    "effort": "xhigh"
  },
  "store": false,
  "text": {
    "verbosity": "low"
  },
  "stream": true
}

Görsel anlama

json
{
  "model": "gpt-5.4",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "What is in this image?"
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/cat.png",
          "detail": "high"
        }
      ]
    }
  ]
}

Dosya girdisi

PDF içeriği göndermek için file_data ve filename kullanın. file_data tam bir veri URL’si olmalıdır.

json
{
  "model": "gpt-5.4",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Summarize the key points in this PDF."
        },
        {
          "type": "input_file",
          "file_data": "data:application/pdf;base64,JVBERi0xLjQKJc...",
          "filename": "report.pdf"
        }
      ]
    }
  ]
}

Görsel ve dosya girdisi

json
{
  "model": "gpt-5.4",
  "input": [
    {
      "type": "message",
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Give three conclusions based on the image and attachment."
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/chart.png",
          "detail": "high"
        },
        {
          "type": "input_file",
          "file_data": "data:application/pdf;base64,JVBERi0xLjQKJc...",
          "filename": "notes.pdf"
        }
      ]
    }
  ]
}

Akışlı çıktı

json
{
  "model": "gpt-5.4",
  "stream": true,
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Explain this diagram step by step."
        },
        {
          "type": "input_image",
          "image_url": "https://example.com/diagram.png"
        }
      ]
    }
  ]
}

Yanıt

Akışsız yanıtlar OpenAI Responses tarzını izler. Gerçek alanlar seçilen modelin yeteneklerine göre değişebilir.

idstring

Benzersiz yanıt kimliği.

objectstring

Yanıt nesnesi türü, genellikle response.

created_atinteger

Oluşturulma zaman damgası.

modelstring

Gerçekte kullanılan model.

outputobject[]

Çıktı öğeleri listesi. Yaygın öğeler message, function_call ve araçla ilgili çıktılardır.

usageobject

input_tokens, output_tokens ve total_tokens gibi token kullanım istatistikleri.

Başarılı yanıt örneği

json
{
  "id": "resp_123",
  "object": "response",
  "created_at": 1766534400,
  "model": "gpt-5.4",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "text": "The image shows a cat, and the attachment is a document about pet care."
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 128,
    "output_tokens": 42,
    "total_tokens": 170
  }
}

Akışlı yanıt

stream=true olduğunda uç nokta Server-Sent Events döndürür.

text
event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":"The image"}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_123"}}

response.completed gelene veya bağlantı kapanana kadar olayları okuyun.

Hata yanıtı

Tam kod başvurusu, protokol farkları ve tanılama adımları için Hata kodları ve sorun giderme sayfasına bakın.

Platformun ürettiği HTTP hataları error sarmalayıcısı yerine aşağıdaki düz alanları kullanır. Bazı üst sağlayıcı hataları özgün yapılarını koruyabilir; başlamış SSE akışındaki hatalar bu HTTP yanıt örneğini izlemez.

json
{
  "code": 40000,
  "message": "Insufficient credit. Required: 30000, Available: 20000",
  "type": "api_error"
}

Notlar

  • Responses uç noktası messages değil input kullanır. İstemciniz yalnızca messages gönderiyorsa /openai/v1/chat/completions kullanın.
  • Görsel girdisi input_image kullanır; image_url herkese açık http:// veya https:// URL’si olmalıdır. Görsellerde Base64 veri URL’leri desteklenmez.
  • Dosya girdisi input_file kullanır. PDF’ler için file_data ve filename kullanın; file_data tam data:application/pdf;base64,... URL’si olmalıdır.
  • Ses girdi/çıktısı, görsel oluşturma araçları, dosya arama ve diğer gelişmiş yetenekler seçilen modele ve mevcut özelliklere bağlıdır.
  • Bu sayfada listelenen alanlar mevcut genel Responses istek sözleşmesini oluşturur; listelenmeyen alanların kullanılabilir olduğunu varsaymayın.
  • /openai/responses önerilen genel yoldur.
  • /v1/responses aynı genel istek ve yanıt sözleşmesini izler.
  • /compat/v1/responses aynı genel istek ve yanıt sözleşmesini izler.
  • /openai/v1/responses aynı genel istek ve yanıt sözleşmesini izler.