Dearbhadh

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Headers a tha air an aontachadh

Thèid an dà header a leughadh air gach endpoint /v1, ge bith dè an cruth a bhruidhneas an endpoint. Cuir fear dhiubh.

Le SDK OpenAI, suidhich an iuchair agus am base URL; cuiridh an SDK 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!"}
    ]
  }'

Le SDK Anthropic, suidhich an iuchair agus am base URL gun /v1; cuiridh an SDK 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!"}
    ]
  }'

Dè na h-endpoints air a bheil feum air iuchair

D’ iuchair

• Is e iuchair sk- agus 43 caractaran à A–Z, a–z, 0–9, - agus _: 46 caractar gu h-iomlan.
• Tha dìreach aon iuchair aig gach cunntas. Thèid a cruthachadh a’ chiad turas a dh’fhosglas tu Keys & usage.
• Bheir an iuchair làn-inntrigeadh dhan API airson do chunntais: gach endpoint, gach modail agus am balance gu lèir.
• Chan eil ceann-latha aig iuchair. Obraichidh i gus an ùraich no an cuir thu à bith i.

Ùraich agus cuir à bith

Ùraichidh agus cuiridh tu an iuchair à bith air an duilleag Keys & usage. Iuchraichean & cleachdadh

• Bidh an dà chuid gan cur an gnìomh sa bhad: thèid an ath iarrtas leis an t-seann iuchair a fhreagairt le 401. Gabh ri 60 diogan mar an crìoch àrd mus tèid an seann iuchair a dhiùltadh anns gach àite.
• Cleachdaidh gach client dhen chunntas an aon iuchair, agus mar sin ruigidh ùrachadh orra uile. Cuir an iuchair ùr dha na clients agad dìreach às dèidh dhut ùrachadh.
• Buinidh balance, cleachdadh agus dìon thar-thuiltidh dhan chunntas, chan ann dhan iuchair. Leanaidh iuchair ùr leis an aon bhalance agus an aon chunntadh iarrtasan airson na mionaid làithrich.

Mearachdan

Tha staid 401 agus seòrsa authentication_error aig gach fàilligeadh dearbhaidh. Tha an teachdaireachd a’ sealltainn an diofar eadar na cùisean.

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

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

• Air a h-uile slighe ach /v1/messages tha code: "invalid_api_key" cuideachd san nì error, airson iuchair a tha a dhìth cuideachd, agus param: null.
• Thèid an iuchair a sgrùdadh mus tèid a’ bhodhaig a leughadh. Gheibh iarrtas gun iuchair dhligheach 401 fiù ‘s ma tha a bhodhaig mì-dhligheach no ro mhòr.
• Chan eil luach Authorization: Bearer nach tòisich le sk- air a làimhseachadh mar iuchair API. Gheibh e 401 le teachdaireachd gu bheil an token mì-dhligheach no air falbh.

Brabhsairean agus CORS

• Cha fhreagair an API iarrtasan brabhsair cross-origin ach airson liosta stèidhichte de thùsan. Chan urrainn do JavaScript air duilleag à tùs eile freagairtean /v1 a leughadh.
• Gairm an API on server agad agus leig leis an duilleag agad bruidhinn ris an server agad. Cumaidh sin cuideachd an iuchair a-mach à tùs na duilleige.
• Chan eil buaidh air còd taobh an server no air innealan loidhne-àithne: chan eil brabhsairean a’ cur an riaghailt seo an sàs.
• Chan eil clàradh a-steach air shannon-ai.com a’ dearbhadh iarrtasan /v1. Cha tèid cookies a leughadh an sin; is e an iuchair an aon dearbh-aithne.
• Airson tùs a tha ceadaichte, faodaidh brabhsair content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta agus x-request-id a chur, agus faodaidh e header na freagairt x-request-id a leughadh.

A’ cumail na h-iuchrach sàbhailte

• Cùm an iuchair air server. Na cuir i ann an duilleagan-lìn, apan mobile no ionadan-glèidhidh poblach: faodaidh neach sam bith aig a bheil i do bhalance gu lèir a chaitheamh.
• Luchdaich an iuchair o chaochladair àrainneachd no stòr dhìomhaireachdan an àite a sgrìobhadh dhan chòd.
• Ma dh’fhaodadh an iuchair a bhith air leigeil a-mach, ùraich i air Keys & usage. Stadaidh an seann iuchair ag obair sa bhad.
• Às dèidh leigeil a-mach, leugh liosta nan iarrtasan air Keys & usage. Seallaidh i gach iarrtas a rinn an iuchair sna 30 latha mu dheireadh.