API metadata daftar model
Model
API metadata daftar model
- GET /v1/models: daftar dasar dengan kategori, kemampuan, dan skema parameter melalui expand
- Mendukung filter
categorydan JSON Schema melaluiexpand=parameters - Cocok untuk otomatisasi, formulir dinamis, dan validasi awal
GET
API metadata daftar model
API metadata daftar model (
GET /v1/models) secara default hanya mengembalikan kolom dasar seperti nama model. Menambahkan parameter kueri expand akan menyertakan informasi berikut pada setiap model:- Kategori (
category):chat/image/video/audio - Tag kemampuan (
capability_tags): misalnyaText to VideodanImage to Image - Kontrak parameter (
parameters): JSON Schema standar yang menunjukkan kolom wajib/opsional, enumerasi, rentang, dan nilai default
Kompatibilitas mundur: tanpa expand (atau dengan nilai yang tidak dikenali), respons identik dengan format yang sudah ada sehingga klien lama tidak terpengaruh.
Mendapatkan daftar model dengan metadata
GET/v1/models
Header permintaan
Parameter kueri
Cakupan model yang dikembalikan sama seperti saat
expand tidak digunakan: ditentukan oleh pembatasan model dan grup yang ditetapkan pada API key.
Contoh 1: hanya kategori
cURL
Contoh 2: kontrak parameter lengkap untuk model video
cURL
input_schema.properties hanya menampilkan sebagian kolom):
Kolom respons
Kolom item
category=unknown berarti platform belum mencatat metadata kategori model tersebut (biasanya nama nonstandar yang dikonfigurasi dalam daftar model yang diizinkan untuk API key). Model tetap dapat dipanggil seperti biasa.
Tag kemampuan
Blok parameters
Cara membaca input_schema
Ini adalah JSON Schema standar yang dapat langsung digunakan oleh alat umum seperti ajv, pydantic, dan openapi-generator.- Parameter wajib = array
requiredtingkat atas;anyOfberarti “setidaknya satu dari kombinasi berikut” (pada contoh di atas, salah satu dariprompt,messages, atau tiga input media referensi) - Nilai enumerasi =
enumpada properti - Rentang =
minimum/maximum - Nilai default =
default additionalProperties: true: mengizinkan parameter ekstensi khusus model yang tidak tercantum dalam skema (diteruskan melaluimetadata)
Meminta satu model
Selain daftar, tersedia endpoint khusus untuk kontrak satu model (struktur yang sama, dengan blok tambahan yang menjelaskan idempotensi dan kontrak respons):Catatan
- Saat ini model chat / audio hanya memiliki
categorydancapability_tags, tanpaparameters(kontrak parameter saat ini mencakup image / video dan akan ditambahkan untuk kategori lain pada versi berikutnya). - Skema merupakan kontrak upaya terbaik; validasi sisi server tetap menjadi acuan akhir. Beberapa batasan dinamis, seperti kombinasi resolusi dan durasi tertentu, mungkin tidak sepenuhnya dinyatakan dalam skema. Server masih dapat menolak permintaan dan memberikan alasan tertentu.
- Kesegaran data dihitung dalam menit. Katalog disimpan dalam cache, sehingga model baru atau perubahan parameter mungkin membutuhkan beberapa menit untuk muncul.
- Respons lengkap
expand=parametersdapat mencapai ratusan KB. Filter dengancategoryjika memungkinkan dan kirimAccept-Encoding: gzip. - Parameter ini hanya berlaku untuk daftar model berformat OpenAI. Daftar model berformat Anthropic / Gemini tidak mendukung
expand.