Nyocha njirimara

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Headers a na-anabata

A na-agụ headers abụọ ahụ n'endpoint /v1 ọ bụla, ọ bụla usoro endpoint ahụ na-asụ. Zipu otu n'ime ha.

Na SDK OpenAI, setịpụ key na base URL; SDK na-ezipụ Authorization: Bearer.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1"
)

response = client.chat.completions.create(
    model="shannon-3",
    messages=[
        {"role": "user", "content": "Hello, Shannon!"}
    ]
)

print(response.choices[0].message.content)

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://api.shannon-ai.com/v1'
});

const response = await client.chat.completions.create({
  model: 'shannon-3',
  messages: [
    { role: 'user', content: 'Hello, Shannon!' }
  ]
});

console.log(response.choices[0].message.content);

curl -X POST "https://api.shannon-ai.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "messages": [
      {"role": "user", "content": "Hello, Shannon!"}
    ]
  }'

Na SDK Anthropic, setịpụ key na base URL na-enweghị /v1; SDK na-ezipụ x-api-key.

import anthropic

client = anthropic.Anthropic(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com"
)

message = client.messages.create(
    model="shannon-3",
    max_tokens=1024,
    messages=[
        {"role": "user", "content": "Hello, Shannon!"}
    ]
)

print("".join(block.text for block in message.content if block.type == "text"))

import Anthropic from '@anthropic-ai/sdk';

const client = new Anthropic({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://api.shannon-ai.com'
});

const message = await client.messages.create({
  model: 'shannon-3',
  max_tokens: 1024,
  messages: [
    { role: 'user', content: 'Hello, Shannon!' }
  ]
});

console.log(message.content.filter((block) => block.type === 'text').map((block) => block.text).join(''));

curl -X POST "https://api.shannon-ai.com/v1/messages" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "Hello, Shannon!"}
    ]
  }'

Endpoint ndị chọrọ key

Key gị

• Key bụ sk- sochiri mkpụrụedemede 43 sitere na A–Z, a–z, 0–9, - na _: mkpụrụedemede 46 n'ozuzu.
• Akaụntụ ọ bụla nwere otu key kpọmkwem. A na-emepụta ya mgbe mbụ ị meghere Keys & usage.
• Key na-enye ohere zuru ezu na API maka akaụntụ gị: endpoint ọ bụla, model ọ bụla na balance niile.
• Key enweghị ụbọchị ọ ga-agwụ. Ọ na-arụ ọrụ ruo mgbe i gbanwere ma ọ bụ kagbuo ya.

Gbanwee na kagbuo

Ị na-agbanwe ma kagbuo key na peeji Keys & usage. Keys & usage

• Abụọ ahụ na-emetụta ozugbo: a na-azaghachi request ọzọ nwere key ochie na 401. Were sekọnd 60 dị ka oke elu tupu a jụ key ochie n'ebe niile.
• Client ọ bụla nke akaụntụ na-eji otu key, yabụ mgbanwe na-erute ha niile. Tinye key ọhụrụ n'ime client gị ozugbo ị gbanwere.
• Balance, usage na flood protection bụ nke akaụntụ, ọ bụghị nke key. Key ọhụrụ na-aga n'ihu na otu balance na otu ọnụọgụ request maka nkeji nke ugbu a.

Njehie

Ọdịda nwapụta ọ bụla nwere status 401 na ụdị authentication_error. Ozi ahụ na-ekewa ikpe ndị ahụ.

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key",
    "code": "invalid_api_key",
    "param": null
  }
}

{
  "type": "error",
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key"
  }
}

• Na ụzọ ọ bụla ma e wezụga /v1/messages, error object nwekwara code: "invalid_api_key", maka key na-efu efu nakwa, na param: null.
• A na-enyocha key tupu a gụọ body. Request na-enweghị key ziri ezi na-enweta 401 ọbụna mgbe body ya na-ezighi ezi ma ọ bụ buru ibu.
• Uru Authorization: Bearer anaghị amalite na sk- ka a naghị ewere dị ka API key. Ọ na-enweta 401 nwere ozi na token ezighi ezi ma ọ bụ gafere oge.

Browsers na CORS

• API na-azaghachi cross-origin browser requests naanị maka ndepụta origins akọwapụtara. JavaScript dị na peeji nke origin ọzọ enweghị ike ịgụ azịza /v1.
• Kpọọ API site na server gị ma hapụ peeji gị ka ọ na-agwa server gị okwu. Nke ahụ na-edebekwa key ahụ n'èzí source nke peeji.
• Koodu server-side na ngwa command-line adịghị emetụta: browsers naanị na-etinye iwu a.
• Ịbanye na shannon-ai.com anaghị eme ka requests /v1 bụrụ nke a nwapụtara. A naghị agụ cookies n'ebe ahụ; key bụ naanị nkwenye.
• Maka origin e kwere, browser nwere ike iziga content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta na x-request-id, ma nwee ike ịgụ reply header x-request-id.

Idebe key n'ọdịmma

• Debe key na server. Atụkwala ya na peeji weebụ, ngwa mobile ma ọ bụ repositories ọha: onye ji ya nwere ike iri balance gị niile.
• Bunye key site na environment variable ma ọ bụ secret store kama ide ya n'ime koodu.
• Ọ bụrụ na key nwere ike ịbụ nke wepụtara, gbanwee ya na Keys & usage. Key ochie na-akwụsị ịrụ ọrụ ozugbo.
• Mgbe nkwafu gasịrị, gụọ ndepụta request na Keys & usage. Ọ na-egosi request ọ bụla key mere n'ime ụbọchị 30 gara aga.