Tús Tapa

Déan chéad iarratas: faigh d'eochair, seol teachtaireacht amháin agus léigh an freagra. Labhraíonn an API formáidí OpenAI agus Anthropic, mar sin oibríonn an SDK a úsáideann tú cheana tar éis duit a bhun-URL agus a eochair a athrú.

1. Faigh d'eochair

Tá eochair API amháin ag gach cuntas. Sínigh isteach, oscail Eochracha agus úsáid agus cóipeáil í. Oibríonn an eochair ar gach críochphointe agus ar gach múnla. Eochracha agus úsáid

2. Díriú do chliant ar an API

Tá na críochphointí go léir faoi bhun bhun-URL amháin. Glacann SDK OpenAI leis agus /v1 ag an deireadh; glacann SDK Anthropic leis gan é, mar cuireann sé /v1/messages leis féin.

Cliant	Bun-URL
SDKanna OpenAI agus cliaint atá comhoiriúnach le OpenAI	`https://api.shannon-ai.com/v1`
SDKanna Anthropic	`https://api.shannon-ai.com`

Táirgeann trí chríochphointe téacs. Sroicheann siad na múnlaí céanna; roghnaigh an ceann a n-úsáideann do chód a fhormáid cheana.

Críochphointe	Formáid
`POST /v1/chat/completions`	OpenAI Chat Completions
`POST /v1/messages`	Anthropic Messages
`POST /v1/responses`	OpenAI Responses

3. Seol chéad iarratas

Seol teachtaireacht user amháin chuig shannon-3 ar an gcríochphointe Chat Completions. Cuir d'eochair in ionad YOUR_API_KEY.

POST https://api.shannon-ai.com/v1/chat/completions

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!"}
    ],
    max_tokens=1024
)

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!' }
  ],
  max_tokens: 1024
});

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

package main

import (
    "context"
    "fmt"
    openai "github.com/sashabaranov/go-openai"
)

func main() {
    config := openai.DefaultConfig("YOUR_API_KEY")
    config.BaseURL = "https://api.shannon-ai.com/v1"
    client := openai.NewClientWithConfig(config)

    resp, err := client.CreateChatCompletion(
        context.Background(),
        openai.ChatCompletionRequest{
            Model: "shannon-3",
            Messages: []openai.ChatCompletionMessage{
                {Role: "user", Content: "Hello, Shannon!"},
            },
            MaxTokens: 1024,
        },
    )
    if err != nil {
        panic(err)
    }
    fmt.Println(resp.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!"}
    ],
    "max_tokens": 1024
  }'

Réimse	Cineál	Réamhshocrú	Cur síos
`model`	`string`		Id an mhúnla a fhreagraíonn. Liostaítear na ids ar Múnlaí agus praghsáil.
`messages`	`array`		An comhrá go dtí seo: réada le `role` agus `content`. Is é an teachtaireacht `user` dheireanach an prompt. Riachtanach.
`max_tokens`	`integer`	`4096`	Buiséad aschuir an iarratais, ó 1 go 65,536. Cuireann an t-iarratas an méid seo in áirithe ó d'iarmhéid agus muirearaítear é as an méid a d'úsáid sé i ndáiríre.
`stream`	`boolean`	`false`	Seolann `true` an freagra píosa ar phíosa agus é á scríobh.

Is JSON é corp an iarratais agus teastaíonn an ceanntásc Content-Type: application/json. Tá an liosta iomlán réimsí ar leathanach an chríochphointe. Chat Completions

An freagra

Fillfidh glao gan stream réad JSON amháin nuair a bhíonn an freagra críochnaithe. Samplaí iad na téacsanna agus na huimhreacha thíos.

200 JSON

{
  "id": "chatcmpl-9b2f6c1e4a7d4f0f8a3c5d2e1b6a7c90",
  "object": "chat.completion",
  "created": 1791590400,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! What would you like to work on?",
        "reasoning_content": "A greeting. A short, friendly reply fits."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1386,
    "completion_tokens": 74,
    "total_tokens": 1460
  }
}

Réimse	Cineál	Cur síos
`id`	`string`	`chatcmpl-` agus ina dhiaidh 32 carachtar heicsidheachúlach.
`object`	`string`	`chat.completion` i gcónaí.
`created`	`integer`	Am an fhreagra i soicindí Unix.
`model`	`string`	Id foilsithe an mhúnla a d'fhreagair, fiú nuair a sheol tú ailias nó litriú eile.
`choices`	`array`	Iontráil amháin i gcónaí, le `index` 0.
`choices[0].message.role`	`string`	`assistant` i gcónaí.
`choices[0].message.content`	`string \| null`	An freagra. Is féidir é a bheith `null` nuair a iompraíonn an freagra `tool_calls`.
`choices[0].message.reasoning_content`	`string \| null`	Réasúnaíocht an mhúnla roimh a fhreagra, nó `null` mura bhfuil aon cheann ann.
`choices[0].message.tool_calls`	`array`	Ann amháin nuair a ghlaonn an múnla ar cheann de na huirlisí a dhearbhaigh tú.
`choices[0].finish_reason`	`string`	`stop` do fhreagra, `tool_calls` nuair a ghlaonn an múnla uirlis.
`usage.prompt_tokens`	`integer`	Na tokens a léigh an múnla don fhreagra seo. Ar `shannon-2-*` agus ar theaghlach Shannon 3 is féidir é seo a bheith níos mó ná an téacs a sheol tú.
`usage.completion_tokens`	`integer`	Na tokens a scríobh an múnla.
`usage.total_tokens`	`integer`	An t-iomlán. Ríomhtar muirear múnla Shannon ón uimhir seo.

Tá comhaireamh token i usage, ní airgead. Taispeántar ar Eochracha agus úsáid, in aghaidh an iarratais, an méid a thóg an glao as d'iarmhéid; tá an ríomh ar Teorainneacha agus iarmhéid. Teorainneacha agus iarmhéid
Tá an ceanntásc x-request-id ar gach freagra, fiú ar earráid agus ar shruth. Má tá ceanntásc x-request-id ar d'iarratas, filleann a luach; seachas sin is 12 charachtar heicsidheachúlacha an luach. Coinnigh i do logaí é: ainmníonn sé an t-iarratas amháin seo.

An glao céanna mar shruth

Socraigh stream ar true chun an freagra a léamh agus é á scríobh. Fanann gach rud eile san iarratas mar a bhí.

from openai import OpenAI

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

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

for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

import OpenAI from 'openai';

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

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

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content ?? '');
}

curl -N -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!"}
    ],
    "max_tokens": 1024,
    "stream": true
  }'

Is líne amháin é gach fráma den sruth a thosaíonn le data: agus a bhfuil réad JSON ann. Fráma amháin, priontáilte ar roinnt línte:

Fráma amháin

{
  "id": "chatcmpl-9b2f6c1e4a7d4f0f8a3c5d2e1b6a7c90",
  "object": "chat.completion.chunk",
  "created": 1791590400,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "delta": {
        "content": "Hello! "
      },
      "finish_reason": null
    }
  ]
}

Frámaí, in ord	delta	finish_reason
Fad a dhéanann an múnla réasúnaíocht. Nialas fráma nó níos mó.	`{"reasoning_content": "…"}`	`null`
An freagra, píosa ar phíosa. Nialas fráma nó níos mó.	`{"content": "…"}`	`null`
An fráma JSON deireanach. Iompraíonn sé `usage` freisin; ní gá duit é a iarraidh.	`{}`	`"stop"`
Deireadh an tsrutha: an líne `data: [DONE]`.

Tá stádas 200 agus content-type: text/event-stream ar an bhfreagra. Is líne data: <json> é gach fráma agus ina dhiaidh líne fholamh.
Tagann líne : ping gach 15 soicind. Is nóta tráchta é a choinníonn an nasc oscailte; scipeálann cliaint SSE é.
Tagann teip tar éis don sruth oscailt mar fhráma data: {"error": {…}}. Fanann an stádas 200, mar sin seiceáil na frámaí.

Sruthú

Má theipeann ar an nglao

Is réad JSON é earráid le error ina bhfuil type agus message. Seo na freagraí is minice a bhuaileann an chéad ghlao leo.

Stádas	Cineál	Teachtaireacht	Cad is brí leis
`401`	`authentication_error`	`Missing authentication`	Níor shroich aon eochair an API. Seol `Authorization: Bearer` agus ansin d'eochair.
`401`	`authentication_error`	`Invalid API key`	Ní hí an eochair reatha chuntais í. Cóipeáil arís í ó Eochracha agus úsáid.
`400`	`invalid_request_error`	`unknown model: <id>`	Ní id foilsithe é `model`. Úsáid id ó Múnlaí agus praghsáil.
`422`	`invalid_request_error`	`Failed to deserialize the JSON body into the target type…`	Tá cineál JSON mícheart ar réimse, nó tá `messages` ar iarraidh.
`429`	`rate_limit_error`	`Quota exceeded. Upgrade your plan at shannon-ai.com/plan`	Ní oireann buiséad aschuir an iarratais d'iarmhéid.

Láimhseáil Earráide

Cá dtéann tú ansin

Múnlaí agus praghsáil — Roghnaigh múnla: ids, fuinneoga comhthéacs agus praghsanna.
Chat Completions — Gach réimse iarratais, réimse freagra agus imeacht sruth den chríochphointe a ghlaoigh tú.
Sruthú — Frámaí sruth, línte keep-alive agus earráidí laistigh de shruth.
Glaonna Feidhme — Lig don mhúnla glaoch ar do fheidhmeanna.
Teorainneacha agus iarmhéid — Cad a chuireann iarratas in áirithe agus cad a chosnaíonn sé, agus cé mhéad iarratas a fhéadfaidh tú a sheoladh.
Clós Súgartha API — Bain triail as iarratais sa bhrabhsálaí le d'eochair.