Skip to main content
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): misalnya Text to Video dan Image to Image
  • Kontrak parameter (parameters): JSON Schema standar yang menunjukkan kolom wajib/opsional, enumerasi, rentang, dan nilai default
Gunakan API ini untuk mengambil katalog lengkap sekali lalu membuat kode klien, membangun formulir parameter secara dinamis, atau memvalidasi permintaan secara lokal sebelum dikirim.
Kompatibilitas mundur: tanpa expand (atau dengan nilai yang tidak dikenali), respons identik dengan format yang sudah ada sehingga klien lama tidak terpengaruh.
Cakupan model: model yang dikembalikan ditentukan oleh pembatasan model dan grup yang ditetapkan pada API key. category=unknown berarti platform belum mencatat metadata kategori model tersebut.

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
Satu item (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 required tingkat atas; anyOf berarti “setidaknya satu dari kombinasi berikut” (pada contoh di atas, salah satu dari prompt, messages, atau tiga input media referensi)
  • Nilai enumerasi = enum pada properti
  • Rentang = minimum / maximum
  • Nilai default = default
  • additionalProperties: true: mengizinkan parameter ekstensi khusus model yang tidak tercantum dalam skema (diteruskan melalui metadata)

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

  1. Saat ini model chat / audio hanya memiliki category dan capability_tags, tanpa parameters (kontrak parameter saat ini mencakup image / video dan akan ditambahkan untuk kategori lain pada versi berikutnya).
  2. 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.
  3. Kesegaran data dihitung dalam menit. Katalog disimpan dalam cache, sehingga model baru atau perubahan parameter mungkin membutuhkan beberapa menit untuk muncul.
  4. Respons lengkap expand=parameters dapat mencapai ratusan KB. Filter dengan category jika memungkinkan dan kirim Accept-Encoding: gzip.
  5. Parameter ini hanya berlaku untuk daftar model berformat OpenAI. Daftar model berformat Anthropic / Gemini tidak mendukung expand.