Gambaran keseluruhan

Endpoint

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

https://api.shannon-ai.com

Tiga endpoint yang menghasilkan teks mencapai model yang sama. Pilih yang formatnya sudah digunakan oleh kod anda.

Asas permintaan

• Badan setiap POST ialah satu objek JSON, sehingga 32 MiB.
• Medan yang tidak dikenali oleh API tidak menyebabkan ralat dan tidak mempunyai kesan. Permintaan yang ditulis untuk penyedia lain tidak gagal kerana medan tambahan.
• Medan yang dikenali dengan jenis JSON yang salah, atau medan wajib yang tiada, dijawab dengan 422. Badan yang bukan JSON yang sah dijawab dengan 400.
• model ialah salah satu id pada Model & harga. Huruf besar dan kecil tidak penting.

Balasan ialah JSON, atau stream server-sent events apabila permintaan menetapkan stream kepada true. Setiap endpoint menjawab dalam formatnya sendiri. Setiap balasan mempunyai header x-request-id.

Apa yang dilalui oleh permintaan

Permintaan disemak mengikut urutan tetap sebelum model berjalan. Semakan pertama yang gagal akan menjawab, jadi 401 belum memberitahu anda apa-apa tentang badan.

Bentuk ralat

Ralat ialah objek JSON dengan error yang memegang type dan message. /v1/messages membungkusnya seperti yang dijangka oleh SDK Anthropic; setiap laluan lain menggunakan 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 wujud pada sesetengah ralat: anggap ia pilihan. param sentiasa null.
• Selepas stream bermula, statusnya sudah 200. Kegagalan kemudian tiba sebagai bingkai ralat di dalam stream.
• Setiap balasan ralat membawa header x-request-id.

Pengendalian Ralat

Pengebilan dan baki

• Terdapat satu baki bagi setiap akaun, dan sembang serta API berkongsinya: kuota pelan hari ini dahulu, kemudian kredit yang dibeli. API tidak mempunyai kuota sendiri.
• Permintaan menempah bajet outputnya (max_tokens, lalai 4,096) dan kemudian dicaj untuk token yang benar-benar digunakannya, pada harga model.
• Setiap balasan melaporkan bilangan tokennya dalam usage. Halaman Kunci & penggunaan menunjukkan baki dan kos setiap permintaan.
• Setiap permintaan dilayan sama rata. Satu-satunya had pada kadar permintaan ialah flood protection: 120 permintaan seminit bagi setiap akaun. Permintaan yang dihantar secara selari menunggu dalam barisan.

Had dan baki Model & harga Kunci & penggunaan

Medan yang bergantung pada model

Setiap model menerima permintaan yang sama. Beberapa medan hanya berkesan pada sesetengah model; jadual menamakan tempatnya. Halaman endpoint menyenaraikan setiap medan.

Chat Completions

Datang daripada SDK OpenAI

• Tetapkan base URL kepada https://api.shannon-ai.com/v1 dan kunci kepada kunci Shannon anda. Panggilan Chat Completions dan Responses kemudian berfungsi dengan SDK seadanya.
• model mestilah id Shannon. Nama model penyedia lain, seperti gpt-4o, dijawab dengan 400 dan unknown model.
• Penaakulan datang dalam medan tersendiri: reasoning_content di sebelah content, dalam mesej dan dalam delta stream.
• Stream sentiasa membawa usage dalam chunk terakhirnya, bersama finish_reason.
• Panggilan alat dalam stream tiba sebagai satu chunk dengan rentetan arguments yang lengkap.
• Balasan mempunyai satu choice.
• Laluan API OpenAI yang tiada dalam jadual di atas, seperti /v1/embeddings, dijawab dengan 404.

Datang daripada SDK Anthropic

• Tetapkan base URL kepada https://api.shannon-ai.com, tanpa /v1, dan kunci kepada kunci Shannon anda. SDK menghantarnya sebagai x-api-key.
• model mestilah id Shannon.
• max_tokens adalah pilihan pada API ini. Nilai lalainya 4,096.
• Balasan memegang blok kandungan berjenis thinking, text dan tool_use. Blok pertama tidak selalunya teks: pilih blok mengikut type.
• stop_reason ialah end_turn atau tool_use. Stream model Shannon juga boleh berakhir dengan max_tokens.
• anthropic-version dan anthropic-beta diterima, jadi SDK berfungsi tanpa perubahan. Permintaan tidak memerlukannya.
• Ralat pada /v1/messages mempunyai bentuk Anthropic: {"type": "error", "error": {…}}.

Alat pengekodan yang menggunakan format ini disediakan dengan cara yang sama: base URL, kunci dan id Shannon sebagai model. Alat pengekodan CLI