Xaqiijinta

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Header-yada la aqbalo

Labada header waa la akhriyaa endpoint kasta oo /v1 ah, qaab kasta oo endpoint-ku ku hadlo. Dir mid iyaga ka mid ah.

OpenAI SDK, deji furaha iyo base URL-ka; SDK-gu wuxuu diraa 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!"}
    ]
  }'

Anthropic SDK, deji furaha iyo base URL-ka /v1 la'aanteed; SDK-gu wuxuu diraa 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-yada fure u baahan

Furahaaga

• Furuhu waa sk- oo ay raacayaan 43 xaraf oo ka mid ah A–Z, a–z, 0–9, - iyo _: wadar ahaan 46 xaraf.
• Akoon kasta wuxuu leeyahay hal fure oo keliya. Waxaa la sameeyaa markii ugu horreysay ee aad furto Fure & isticmaal.
• Furuhu wuxuu akoonkaaga siiyaa gelid buuxda API-ga: endpoint kasta, model kasta iyo haraagga oo dhan.
• Furuhu ma laha taariikh dhicid. Wuu shaqeeyaa ilaa aad beddesho ama meel mariso.

Beddel iyo meel mar

Furaha waxaad ku beddeshaa oo ku meel marisaa bogga Fure & isticmaal. Fure & isticmaal

• Labaduba isla markiiba ayay dhaqan galaan: codsiga xiga ee furaha hore wuxuu helaa 401. 60 ilbiriqsi u qaado xadka sare ka hor inta furaha hore meel walba laga diidin.
• Macmiil kasta oo akoonka ah wuxuu isticmaalaa isla furaha, sidaas darteed beddelku wuxuu gaarayaa dhammaantood. Furaha cusub geli macmiilashaada isla markii aad beddesho.
• Haraagga, isticmaalka iyo flood protection waxay u dhaxaan akoonka, ma aha furaha. Furaha cusubi wuxuu sii wadaa isla haraagga iyo isla tirada codsiyada daqiiqadda hadda.

Khaladaad

Fashil xaqiijin kasta wuxuu leeyahay xaalad 401 iyo nooc authentication_error. Fariintu waxay kala saartaa kiisaska.

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

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

• Dhammaan jidadka marka laga reebo /v1/messages shayga error wuxuu sidoo kale haystaa code: "invalid_api_key", xataa fure maqan, iyo param: null.
• Furaha waa la hubiyaa ka hor inta jidhka la akhriyin. Codsi aan lahayn fure sax ah wuxuu helaa 401 xataa haddii jidhkiisu khalad yahay ama aad u weyn yahay.
• Qiimaha Authorization: Bearer ee aan ku bilaabmin sk- looma aqoonsado fure API. Wuxuu helaa 401 iyo fariin sheegaysa in token-ku aan sax ahayn ama dhacay.

Browsers iyo CORS

• API-gu wuxuu ka jawaabaa codsiyada browser-ka ee cross-origin kaliya liis go'an oo origins ah. JavaScript ka socda bog origin kale ah ma akhrin karo jawaabaha /v1.
• Ka wac API-ga server-kaaga oo u daa bogga inuu la hadlo server-kaaga. Taasi sidoo kale furaha ka ilaalisaa source-ka bogga.
• Code-ka server-ka iyo qalabka command-line ma saamaysan: xeerkan browsers-ka oo kaliya ayaa dabaqa.
• Gelitaan shannon-ai.com ah ma xaqiijiyo codsiyada /v1. Cookies halkaas lama akhriyo; furuhu waa aqoonsiga kaliya.
• Origin la oggol yahay, browser-ku wuxuu diri karaa content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta iyo x-request-id, wuxuuna akhrisan karaa header-ka jawaabta x-request-id.

Ilaalinta furaha

• Furaha ku hay server. Ha gelin bogagga web, apps-ka mobile ama repositories-ka dadweynaha: ciddii haysata waxay isticmaali kartaa haraagaaga oo dhan.
• Ka rar furaha environment variable ama secret store halkii aad ku qori lahayd code-ka.
• Haddii furuhu daadan karo, ku beddel Fure & isticmaal. Furihii hore isla markiiba wuu joogsanayaa.
• Ka dib daadis, akhri liiska codsiyada ee Fure & isticmaal. Wuxuu muujinayaa codsi kasta oo furuhu sameeyay 30-kii maalmood ee la soo dhaafay.