Fíordheimhniú

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Ceanntásca glactha

Léitear an dá cheanntásc ar gach críochphointe /v1, cibé formáid a labhraíonn an críochphointe. Seol ceann acu.

Le SDK OpenAI, socraigh an eochair agus an URL bonn; seolann 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, socraigh an eochair agus an URL bonn gan /v1; seolann 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!"}
    ]
  }'

Cé acu críochphointí a theastaíonn eochair uathu

D'eochair

• Is éard atá in eochair sk- agus 43 charachtar ó A–Z, a–z, 0–9, - agus _ ina dhiaidh: 46 charachtar san iomlán.
• Tá eochair amháin go díreach ag gach cuntas. Cruthaítear í an chéad uair a osclaíonn tú Eochracha agus úsáid.
• Tugann an eochair rochtain iomlán ar an API do do chuntas: gach críochphointe, gach múnla agus an t-iarmhéid ar fad.
• Níl dáta éaga ar eochair. Oibríonn sí go dtí go rothlaíonn nó go gcúlghairfidh tú í.

Rothlú agus cúlghairm

Rothlaíonn tú agus cúlghairtear an eochair ar an leathanach Eochracha agus úsáid. Eochracha agus úsáid

• Tagann an dá cheann i bhfeidhm láithreach: freagraítear an chéad iarratas eile leis an seanéochair le 401. Caith le 60 soicind mar uasteorainn sula ndiúltaítear don seanéochair i ngach áit.
• Úsáideann gach cliant den chuntas an eochair chéanna, mar sin sroicheann rothlú iad uile. Cuir an eochair nua isteach i do chliaint díreach tar éis duit rothlú.
• Is leis an gcuntas an t-iarmhéid, an úsáid agus an chosaint tuile, ní leis an eochair. Leanann eochair nua ar aghaidh leis an iarmhéid céanna agus leis an líon iarratas céanna don nóiméad reatha.

Earráidí

Tá stádas 401 agus cineál authentication_error ag gach teip fhíordheimhnithe. Idirdhealaíonn an teachtaireacht na cásanna óna chéile.

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

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

• Ar gach cosán seachas /v1/messages tá code: "invalid_api_key" sa réad error freisin, d'eochair ar iarraidh chomh maith, agus param: null.
• Seiceáiltear an eochair sular léitear an corp. Faigheann iarratas gan eochair bhailí 401 fiú nuair a bhíonn a chorp neamhbhailí nó rómhór.
• Ní chaitear le luach Authorization: Bearer nach dtosaíonn le sk- mar eochair API. Faigheann sé 401 le teachtaireacht go bhfuil an token neamhbhailí nó as dáta.

Brabhsálaithe agus CORS

• Ní fhreagraíonn an API d'iarratais brabhsálaí trasbhunaidh ach do liosta seasta bunús. Ní féidir le JavaScript ar leathanach de bhunús eile freagraí /v1 a léamh.
• Glaoigh ar an API ó do fhreastalaí agus lig do do leathanach labhairt le do fhreastalaí. Coinníonn sin an eochair as foinse an leathanaigh freisin.
• Ní chuirtear isteach ar chód taobh an fhreastalaí ná ar uirlisí líne ordaithe: ní chuireann ach brabhsálaithe an riail seo i bhfeidhm.
• Ní fhíordheimhníonn síniú isteach ar shannon-ai.com iarratais /v1. Ní léitear fianáin ansin; is í an eochair an t-aon dintiúr.
• Le haghaidh bunús ceadaithe, féadfaidh brabhsálaí content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta agus x-request-id a sheoladh, agus féadfaidh sé ceanntásc an fhreagra x-request-id a léamh.

An eochair a choinneáil slán

• Coinnigh an eochair ar fhreastalaí. Ná cuir í ar leathanaigh ghréasáin, in aipeanna soghluaiste ná i stórais phoiblí: is féidir leis an duine a bhfuil sí aige d'iarmhéid iomlán a chaitheamh.
• Luchtaigh an eochair ó athróg timpeallachta nó ó stór rúin in ionad í a scríobh isteach i gcód.
• Má d'fhéadfadh an eochair a bheith sceite, rothlaigh í ar Eochracha agus úsáid. Stopann an seanéochair ag obair láithreach.
• Tar éis sceite, léigh liosta na n-iarratas ar Eochracha agus úsáid. Taispeánann sé gach iarratas a rinne an eochair le 30 lá anuas.