Autenticación

Authorization: Bearer YOUR_API_KEY

x-api-key: YOUR_API_KEY

Cabeceiras aceptadas

As dúas cabeceiras lense en todos os endpoints de /v1, sexa cal sexa o formato que fale o endpoint. Envía unha delas.

Cun SDK de OpenAI, define a clave e a URL base; o SDK envía 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!"}
    ]
  }'

Cun SDK de Anthropic, define a clave e a URL base sen /v1; o SDK envía 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!"}
    ]
  }'

Que endpoints precisan unha clave

A túa clave

• Unha clave é sk- seguido de 43 caracteres de A–Z, a–z, 0–9, - e _: 46 caracteres en total.
• Cada conta ten exactamente unha clave. Créase a primeira vez que abres Claves e uso.
• A clave dá acceso completo á API para a túa conta: todos os endpoints, todos os modelos e todo o saldo.
• Unha clave non ten data de caducidade. Funciona ata que a rotes ou a revogues.

Rotar e revogar

Rotas e revogas a clave na páxina Claves e uso. Claves e uso

• Ambas as accións teñen efecto de inmediato: a seguinte solicitude coa clave antiga recibe 401. Considera 60 segundos como o límite máximo ata que a clave antiga se rexeite en todas partes.
• Todos os clientes da conta usan a mesma clave, así que unha rotación chega a todos. Pon a clave nova nos teus clientes xusto despois de rotar.
• O saldo, o uso e a protección contra inundación pertencen á conta, non á clave. Unha clave nova continúa co mesmo saldo e co mesmo reconto de solicitudes do minuto actual.

Erros

Todo fallo de autenticación ten o estado 401 e o tipo authentication_error. A mensaxe distingue os casos.

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

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

• En todas as rutas excepto /v1/messages, o obxecto error contén ademais code: "invalid_api_key", tamén cando falta a clave, e param: null.
• A clave comprógase antes de ler o corpo. Unha solicitude sen unha clave válida recibe 401 aínda que o seu corpo sexa inválido ou demasiado grande.
• Un valor de Authorization: Bearer que non comeza por sk- non se trata como clave API. Recibe 401 cunha mensaxe de que o token é inválido ou caducou.

Navegadores e CORS

• A API só responde a solicitudes de navegador de orixe cruzada para unha lista fixa de orixes. O JavaScript dunha páxina doutra orixe non pode ler as respostas de /v1.
• Chama á API desde o teu servidor e fai que a túa páxina fale co teu servidor. Así tamén a clave queda fóra do código fonte da páxina.
• O código do lado do servidor e as ferramentas de liña de comandos non se ven afectados: esta regra só a aplican os navegadores.
• Iniciar sesión en shannon-ai.com non autentica as solicitudes a /v1. Alí non se len as cookies; a clave é a única credencial.
• Para unha orixe permitida, un navegador pode enviar content-type, authorization, x-api-key, anthropic-version, anthropic-beta, openai-beta e x-request-id, e pode ler a cabeceira de resposta x-request-id.

Manter a clave segura

• Garda a clave nun servidor. Non a metas en páxinas web, aplicacións móbiles nin repositorios públicos: quen a teña pode gastar todo o teu saldo.
• Carga a clave desde unha variable de contorna ou un almacén de segredos en lugar de escribila no código.
• Se a clave puido filtrarse, rótaa en Claves e uso. A clave antiga deixa de funcionar de inmediato.
• Despois dunha filtración, le a lista de solicitudes en Claves e uso. Mostra todas as solicitudes que fixo a clave nos últimos 30 días.