Ringkasan

Endpoint

Setiap endpoint berada di bawah satu base URL dan dilayani melalui HTTPS.

https://api.shannon-ai.com

Ketiga endpoint yang menghasilkan teks menjangkau model yang sama. Pilih yang formatnya sudah dipakai kode Anda.

Dasar-dasar permintaan

• Body setiap POST adalah satu objek JSON, hingga 32 MiB.
• Field yang tidak dikenal API tidak menimbulkan error dan tidak berpengaruh. Permintaan yang ditulis untuk penyedia lain tidak gagal karena field tambahan.
• Field yang dikenal dengan tipe JSON yang salah, atau field wajib yang hilang, dijawab dengan 422. Body yang bukan JSON valid dijawab dengan 400.
• model adalah salah satu id di Models & pricing. Huruf besar dan kecil tidak berpengaruh.

Balasan berupa JSON, atau stream server-sent events ketika permintaan menyetel stream ke true. Setiap endpoint menjawab dalam formatnya sendiri. Setiap balasan memiliki header x-request-id.

Apa yang dilalui permintaan

Permintaan diperiksa dalam urutan tetap sebelum model berjalan. Pemeriksaan pertama yang gagal akan menjawab, jadi 401 belum memberi tahu apa pun tentang body.

Bentuk error

Error adalah objek JSON dengan error yang berisi type dan message. /v1/messages membungkusnya sesuai harapan SDK Anthropic; semua path lain memakai bentuk OpenAI.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• Baca type dan message. code dan param hanya ada pada sebagian error: anggap keduanya opsional. param selalu null.
• Setelah stream dimulai, statusnya sudah 200. Kegagalan kemudian datang sebagai error frame di dalam stream.
• Setiap balasan error membawa header x-request-id.

Penanganan kesalahan

Penagihan dan saldo

• Ada satu saldo per akun, dan chat serta API berbagi saldo itu: kuota paket hari ini lebih dulu, lalu kredit yang dibeli. API tidak memiliki kuota sendiri.
• Permintaan mencadangkan anggaran outputnya (max_tokens, bawaan 4,096) lalu ditagih sesuai token yang benar-benar dipakai, dengan harga model.
• Setiap balasan melaporkan jumlah tokennya di usage. Halaman Keys & usage menampilkan saldo dan biaya setiap permintaan.
• Setiap permintaan dilayani secara setara. Satu-satunya batas laju permintaan adalah flood protection: 120 permintaan per menit per akun. Permintaan yang dikirim paralel menunggu dalam antrean.

Batas dan saldo Model & harga Keys & usage

Field yang bergantung pada model

Setiap model menerima permintaan yang sama. Beberapa field hanya berlaku pada sebagian model; tabel menyebutkan di mana. Halaman endpoint mencantumkan setiap field.

Chat Completions

Datang dari SDK OpenAI

• Setel base URL ke https://api.shannon-ai.com/v1 dan kuncinya ke kunci Shannon Anda. Panggilan Chat Completions dan Responses kemudian berfungsi dengan SDK apa adanya.
• model harus berupa id Shannon. Nama model penyedia lain, seperti gpt-4o, dijawab dengan 400 dan unknown model.
• Penalaran hadir di field tersendiri: reasoning_content di samping content, di dalam pesan dan di delta stream.
• Stream selalu membawa usage di chunk terakhirnya, bersama finish_reason.
• Pemanggilan tool dalam stream datang sebagai satu chunk dengan string arguments yang lengkap.
• Balasan memiliki satu choice.
• Path API OpenAI yang tidak ada di tabel di atas, seperti /v1/embeddings, dijawab dengan 404.

Datang dari SDK Anthropic

• Setel base URL ke https://api.shannon-ai.com, tanpa /v1, dan kuncinya ke kunci Shannon Anda. SDK mengirimnya sebagai x-api-key.
• model harus berupa id Shannon.
• max_tokens bersifat opsional pada API ini. Nilai bawaannya 4,096.
• Balasan berisi blok konten bertipe thinking, text, dan tool_use. Blok pertama tidak selalu berupa teks: pilih blok berdasarkan type.
• stop_reason adalah end_turn atau tool_use. Stream dari model Shannon juga dapat berakhir dengan max_tokens.
• anthropic-version dan anthropic-beta diterima, sehingga SDK berfungsi tanpa perubahan. Permintaan tidak memerlukannya.
• Error pada /v1/messages berbentuk Anthropic: {"type": "error", "error": {…}}.

Tool coding yang memakai format-format ini disiapkan dengan cara yang sama: base URL, kunci, dan id Shannon sebagai model. Tool coding CLI