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.
https://api.apihop.ai/openai/responsesOpenAI 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.
POST https://api.apihop.ai/openai/responsesKimlik doğrulama
Tüm istekler Bearer belirteciyle kimlik doğrulama gerektirir.
Authorization: Bearer YOUR_API_KEYİstek gövdesi
modelstringzorunluVarsayılan: gpt-5.4Responses destekleyen mevcut etkin modeller:
gpt-5.4gpt-5.5gpt-5.6-solgpt-5.6-terragpt-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
usermetin 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:
typestringGirdi öğesi türü.
Yaygın değerler:
message: mesaj girdisi.function_call_output: işlev aracı çağrısının sonucu.
rolestringtype=message olduğunda rol.
Yaygın değerler:
developersystemuserassistant
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_textinput_imageinput_file
textstringtype=input_text olduğunda metin içeriği.
image_urlstringtype=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: autotype=input_image olduğunda görsel ayrıntı düzeyi.
Yaygın değerler:
autolowhigh
file_datastringtype=input_file olduğunda dosya içeriğinin veri URL’si. PDF’ler data:application/pdf;base64,... kullanabilir.
filenamestringtype=input_file olduğunda dosya adı.
instructionsstringModel bağlamına eklenen sistem veya geliştirici talimatları.
max_output_tokensintegerPozitif 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: falseYanıtın akış halinde döndürülüp döndürülmeyeceği.
false: tek bir tam yanıt döndürürtrue: 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.
textobjectMetin çıktısı yapılandırması.
text.formatobject{ "type": "text" } veya JSON şeması gibi metin biçimi yapılandırması.
text.verbositystringlow, 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 | objectAraç seçimi ilkesi.
parallel_tool_callsbooleanParalel araç çağrılarına izin verilip verilmediği.
reasoningobjectAkı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_identifierstringGüvenlik kontrolleri için kararlı son kullanıcı kimliği.
storebooleanYanıt durumunun saklanıp saklanamayacağı.
Model parametresi farkları
- Yerel OpenAI uyumlu Responses iletimi, üst sağlayıcı isteğinde
top_pkorur; doğrulama ve örnekleme davranışı seçilen modele ve üst sağlayıcıya bağlıdır. 2026-09-26 kontrollerigpt-5.5,gpt-5.6-solvegpt-5.6-terraiçintop_p: 0.9kabul 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/responsesuç noktasına uygulanır. Aynı modelin/openai/responses/compact, WebSocket veya durum tutanprevious_response_iddesteklediğ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
{
"model": "gpt-5.4",
"input": "Hello, introduce yourself in one sentence."
}Codex CLI tarzı parametreler
{
"model": "gpt-5.5",
"input": "Reply with READY only.",
"reasoning": {
"effort": "xhigh"
},
"store": false,
"text": {
"verbosity": "low"
},
"stream": true
}Görsel anlama
{
"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.
{
"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
{
"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ı
{
"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.
idstringBenzersiz yanıt kimliği.
objectstringYanıt nesnesi türü, genellikle response.
created_atintegerOluşturulma zaman damgası.
modelstringGerçekte kullanılan model.
outputobject[]Çıktı öğeleri listesi. Yaygın öğeler message, function_call ve araçla ilgili çıktılardır.
usageobjectinput_tokens, output_tokens ve total_tokens gibi token kullanım istatistikleri.
Başarılı yanıt örneği
{
"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.
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.
{
"code": 40000,
"message": "Insufficient credit. Required: 30000, Available: 20000",
"type": "api_error"
}Notlar
Responsesuç noktasımessagesdeğilinputkullanır. İstemciniz yalnızcamessagesgönderiyorsa/openai/v1/chat/completionskullanın.- Görsel girdisi
input_imagekullanır;image_urlherkese açıkhttp://veyahttps://URL’si olmalıdır. Görsellerde Base64 veri URL’leri desteklenmez. - Dosya girdisi
input_filekullanır. PDF’ler içinfile_datavefilenamekullanın;file_datatamdata: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/responsesaynı genel istek ve yanıt sözleşmesini izler./compat/v1/responsesaynı genel istek ve yanıt sözleşmesini izler./openai/v1/responsesaynı genel istek ve yanıt sözleşmesini izler.