Spesifikasi API
Referensi untuk integrasi alur kerja teks, agen, media, dan pengambilan informasi.
https://cicora.ai/api/v1https://cicora.ai/apiReferensi integrasi: pilih parameter dan kemampuan yang tersedia dari pengaturan API akun Anda dan katalog model untuk lingkungan Anda.
Kirim permintaan pertamaMulai
Kirim permintaan pertama, pilih model dari katalog, dan simpan pengenal permintaan untuk diagnosis.
AutentikasiKirim kunci API dalam header Bearer dan pisahkan kredensial produksi dari kredensial pengembangan.
SDK dan klien HTTPGunakan URL dasar yang berbeda untuk klien bergaya OpenAI dan Messages: keduanya menargetkan spesifikasi yang sama, tetapi menyusun path dengan cara berbeda.
CLI dan integrasiKonfigurasikan klien dengan kunci, model, dan URL dasar yang sesuai dengan protokolnya; simpan rahasia di lingkungan.
FAQ pengembangJawaban praktis singkat tentang kunci, URL dasar, model, biaya, dan diagnosis integrasi.
Akun dan katalog
Bangun pemilihan model dari data katalog, bukan daftar yang dikodekan langsung dalam aplikasi Anda.
Tim dan kunci APIPisahkan kunci, pemilik, anggaran, dan jejak penggunaan antar aplikasi dan ruang kerja.
BatasPerlakukan batas kunci, organisasi, model, dan perutean sebagai bagian dari alur kerja pengguna.
Penggunaan dan biayaHubungkan metadata respons dan log permintaan Anda sendiri ke tindakan pengguna yang nyata.
Data dan privasiMinimalkan data yang dikirim, pisahkan pengenal pengguna akhir dari konten, dan kendalikan retensi dalam produk Anda.
Teks dan agen
Buat percakapan multi-giliran dalam format messages yang dikenal dan pilih model untuk setiap permintaan.
Messages APIGunakan format Messages untuk percakapan dengan instruksi sistem tingkat atas dan batas output eksplisit.
Responses APIGunakan satu objek input bila aplikasi Anda memperoleh manfaat dari penanganan item output dan tindakan dalam satu model data.
StreamingTerima token dan delta terstruktur melalui SSE tanpa menunggu respons lengkap.
Alat dan pemanggilan fungsiJelaskan fungsi dengan JSON Schema, jalankan pemanggilan dalam aplikasi Anda, lalu kembalikan hasilnya ke percakapan.
Output terstrukturMinta objek JSON atau JSON Schema ketika respons akan digunakan perangkat lunak, bukan manusia.
PenalaranTetapkan tingkat upaya penalaran per permintaan hanya untuk model yang menyatakan kemampuan tersebut.
PeruteanNyatakan persyaratan eksekusi dalam preferensi terkait penyedia dan simpan hasil sebenarnya untuk observabilitas.
Penyimpanan cache konteksPisahkan konteks berulang agar klien dapat menggunakan penyimpanan cache yang kompatibel jika model yang dipilih mendukungnya.
Pencarian webAmbil sumber terbaru melalui fungsi `web_search` yang dijalankan klien dan pisahkan tautan dari teks yang dihasilkan.
Media dan pengambilan informasi
Unggah file melalui operasi khusus, simpan ID-nya, lalu teruskan referensinya dalam permintaan kompatibel berikutnya.
GambarBuat gambar melalui satu rute dan pilih parameter dari kemampuan model yang dipilih.
VideoMulai pembuatan video sebagai tugas asinkron, simpan ID tugasnya, dan pisahkan pembuatan dari pembacaan hasil.
AudioGunakan operasi terpisah untuk sintesis ucapan, transkripsi, dan input audio ke model.
EmbeddingUbah teks atau input yang didukung menjadi vektor untuk pencarian, pengelompokan, dan rekomendasi.
Pemeringkatan ulangUrutkan kembali sekumpulan kecil kandidat terhadap kueri untuk meningkatkan presisi pengambilan informasi pada tahap akhir.
Eksekusi batchProses operasi yang independen dalam kelompok terkendali jika alur kerja mengizinkan pengiriman asinkron.