지식 기반 / 개발자

API 개요

API는 OpenAI 및 Anthropic 형식을 사용하므로 대부분의 도구 및 SDK는 기본 URL 및 키를 변경하여 작동합니다.The models, generators and balance you use in the app, from your own code.

이 페이지는 편의를 위해 기계 번역되었습니다. 영문 원본이 적용되는 버전입니다.

불이란 무엇인가

HTTP API 사용 nymbot.ai OpenAI 또는 Anthropic 클라이언트가 이미 보내는 동일한 요청에 응답합니다.You get:

• 채팅 완료그리고 The API 응답 그리고 Anthropic 메시지, 스트리밍, 도구, 사진, 추론 및 웹 검색을 통해, 모든 모델에 대 한 카탈로그 그리고 Nymbot의 자체 자동 라우팅을 위해.
• 사진들, 비디오, 연설, 번역기 그리고 삽입.
• 당신의 균형, Lightning Top-ups 부근의 호텔, 귀하의 지갑에서 자동 Top-ups 그리고 A 역사 각 요청에 비해 비용이 얼마나 되는지.

그것은 동일한 두에서 지불됩니다. 균형 앱과 동일한 가격으로 API에 구독이 없으며 무료 혜택이 없습니다: 모든 요청은 구입한 크레딧으로 지불됩니다.

API가하지 않는 것은 Nymbot 자체의 메시지를 추가하는 것입니다. 메시지는 당신이 보냈을 때 모델로 이동합니다 : Nymbot 시스템 인스턴트, 메모리, 날짜 또는 언어 힌트가 없습니다.

기본 URL

모든 끝점은 아래에서 살고 있다. /api/v1/알 수 없는 길이 돌아온다 404 그리고 잘못된 방법으로 불리는 알려진 경로가 반환됩니다. 405둘 다 JSON 입니다.

API는 모든 사이트의 교차 원본 요청에 응답하여 브라우저 페이지가 그것을 호출 할 수 있습니다.무엇이든 브라우저로 보내는 것은 그것을 열면 누구나 읽을 수 있습니다.So only do that with a key that has a small 캡귀하의 nym로 서명된 엔드포인트 (키, 계정 요약, NWC 자동 탑업 및 환불 환불)는 예외입니다 : 브라우저에서 그들은 Nymbot 자신의 사이트에만 응답합니다. 계좌 서명 요청.

각 JSON 몸체를 보내기 Content-Type: application/json모든 다른 종류는 거부됩니다 415, 그래서 간단한 HTML 형식 또는 a text/plain 다른 사이트의 요청은 API에 도달할 수 없습니다. cURL을 사용하면 -H "Content-Type: application/json" 와 함께 -d.

API 키

키는 앱에서 만듭니다.Open 화재 웹 앱의 사이드바 또는 Android 및 iOS의 메뉴에서, 그리고 탭 키 만들기그것에 이름과, 당신이 원한다면, 캡과 만료 날짜를 제공하십시오.

열쇠는 한 번 표시됩니다. 잎을 닫기 전에 안전한 곳으로 복사하십시오: Nymbot은 그것의 지문만 보관하므로 다시 보여줄 수 없습니다. 잃어버린 열쇠는 복구할 수 없습니다; 그것을 취소하고 다른 열쇠를 만듭니다.

열쇠는 마치 sk-nymbot- 다음은 43 개의 문자, 숫자, 스크립트 및 하위 점수입니다.The app lists each key by its name and a short hint such as sk-nymbot-Qm7x…c2Lw.

• 열쇠는 당신의 NIM에 속합니다. 그것은 당신의 균형을 지출하고, 당신의 니머 만 만들 수 있습니다, 변경 또는 철회합니다.
• 캡은 주식에 있습니다. 키는 지출 캡을 가질 수 있으며, 캡은 매일, 매주 (월요일) 또는 매월 (첫 번째) 00:00 UTC에 재설정할 수 있습니다. 그것은 양쪽 잔액, 표준 크레딧은 10 sats와 프로 크레딧은 100으로 계산되므로 요청이 지출하는 잔액에 상관없이 동일한 것을 의미합니다. 403 key_limit_reached, 답이 캡 아래에 들어왔더라도; 오류는 얼마나 남았는지 그리고 언제 캡이 재설정되었는지 말합니다. max_tokens 요청은 실제로 비용이 무엇인지 부과되며 이는 캡에 비해 계산되므로 제공자가 제외된 것보다 더 많은 토큰을보고하는 경우 마지막 요청은 키를 캡을 조금 넘을 수 있습니다; 다음 요청은 거부됩니다.
• 지출을 멈추는 것은 단지 지출을 멈추는 것입니다. 캡에있는 키는 여전히 균형을 확인하고, 역사를 읽고, 모델을 목록하고, 토큰을 계산하고, 이미 시작한 비디오를 확인할 수 있습니다.
• Expiry 는 옵션입니다. 설정한 날짜가 끝나면 키가 작동을 중단합니다.
• 취소는 즉각적이고 최종적이다. 취소된 키는 다음 요청에 실패합니다.이 키는 목록에 남아 있으며, 취소 된 것으로 표시되므로 지출 기록은 여전히 의미가 있습니다.
• 열쇠의 재설정 기간을 변경하면 새 기간이 0에서 시작됩니다.You can have up to 25 active keys, each with its own name.Change a key's reset period starts a new period from zero.

동일한 시트는 각 키가이 기간 동안 지출하고 마지막으로 사용했을 때 모두 잔액과 최근 API 요청을 보여줍니다.The endpoints behind it are documented under 키 관리.

요청을 인증하기

이러한 헤더 중 하나에 키를 보내십시오.그들은 동등하므로 클라이언트가 기본적으로 보내는 것을 사용하십시오.

잃어버린, 알려지지 않은, 취소되거나 만료된 키 반환 401하지만 코드와 함께 missing_api_key, invalid_api_key, revoked_api_key 또는 expired_api_key목록 모델, 오디오 모델 및 목소리, 그리고 지불 방법은 열쇠가 필요하지 않습니다.

사진, 비디오, 음성, 번역 및 삽입은 전혀 열쇠없이 Lightning를 통해 한 번에 하나의 요청에 대해 지불 할 수 있습니다 : 하나없이 요청을 보내고 청구서에 청구서를 지불합니다. 402 대답해 보세요 열쇠 없이 요청에 따라 지불.

키 관리, 계정 요약 및 자동 탑업은 예외입니다 : 그들은 키 대신에 당신의 nym에서 서명을 가져옵니다, 그래서 유출 된 키는 더 많은 키를 만들 수 없습니다. 계좌 서명 요청.

당신의 첫 번째 요청

키를 환경 변수에 넣고 모델에게 뭔가를 물어보십시오. NYMBOT_API_KEY.

cURL

export NYMBOT_API_KEY="sk-nymbot-..."

curl https://nymbot.ai/api/v1/chat/completions \
  -H "Authorization: Bearer $NYMBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "nymbot/auto",
    "messages": [{"role": "user", "content": "What is a Lightning invoice?"}]
  }'

Python

import os
from openai import OpenAI

client = OpenAI(
    base_url="https://nymbot.ai/api/v1",
    api_key=os.environ["NYMBOT_API_KEY"],
)

reply = client.chat.completions.create(
    model="nymbot/auto",
    messages=[{"role": "user", "content": "What is a Lightning invoice?"}],
)
print(reply.choices[0].message.content)

JavaScript

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://nymbot.ai/api/v1",
  apiKey: process.env.NYMBOT_API_KEY,
});

const reply = await client.chat.completions.create({
  model: "nymbot/auto",
  messages: [{ role: "user", content: "What is a Lightning invoice?" }],
});
console.log(reply.choices[0].message.content);

nymbot/auto Nymbot의 자체 라우팅, 표준 잔액에서 지불. anthropic/claude-sonnet-5, Pro 균형에서 그 모델을 사용하십시오. 모델 리스트 모든 ID를 제공합니다.

요청 비용은 얼마나

API는 앱이하는 방식대로 청구합니다.

• 어떤 균형을 nymbot/auto 지출하기 The 표준 균형 (10 sats a credit). 모든 다른 채팅 모델은 프로 표준 이미지 생성기와 표준 음성은 표준 크레딧을 지출합니다; 다른 모든 생성기는 Pro를 지출합니다. Embeddings는 표준 크레딧을 지출합니다. Transcription는 표준 잔액이 그것을 덮을 수있을 때 표준 크레딧을 지출합니다.
• 얼마나 채팅 요청은 모델이 실제로 읽고 썼던 토큰에 측정됩니다.이 가격은 공급자의 게시 된 요금으로 5 % 요금을 추가 한 다음 1.5 배로 배치되므로 공급자의 목록 가격의 1.575 배를 지불합니다. 그것은 라이브 비트코인 가격에 sats로 변환되며 신용의 천분으로 청구됩니다. 프로 사진, 비디오 및 음성은 세대 당, 초 당 또는 문자 당, 오디오의 초당 전송과 동일한 요금과 마진으로 가격됩니다. 표준 이미지는 평면 5 표준 크레딧과 표준 목소리가 평면 3입니다.
• 최소한의 적어도 0.05 크레딧을 실행하는 모든 측정 요청 : 표준 잔액에 절반, Pro에 5 잔액.
• 견디고 그 다음에 정리하십시오. 요청이 실행되기 전에, 가장 비용이 들 수있는 것은 당신이 보낸 것과 그것이 쓸 수있는 가장 많은 토큰에 따라 잔액에서 보관됩니다. 간단한 ASCII 외부의 텍스트는 UTF-8 바이트에서 크기와 ASCII 숫자와 점수는 각각 토큰으로 계산되므로 모든 스크립트, 코드 및 숫자의 텍스트가 완전히 보관됩니다. 보관은 전체 크레딧, 적어도 하나입니다. 따라서 모든 요청은 최소한 표준 잔액에 10 개의 무료 조치 또는 Pro에 100 개의 무료 조치가 필요합니다. 실제 비용 만 청구됩니다. 나머지는 그것이 끝날 때 공개됩니다. 긴 요청은 실행 될 때까지 보관됩니다. 402 insufficient_balance 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 값이 (owed_sats 에서 The nymbot 물체, 그리고 부정적인 잔액). 빚진 것은 다음 잔액에 도달하는 다음 크레딧에서 먼저 지불됩니다. 그것이 지불 될 때까지, 그 잔액에 아무것도 지출 할 수 없습니다 : API, 응용 프로그램, 전송 또는 선물에 의해하지 않습니다.
• 충분한 신용이 없습니다. 잔액이 보유를 덮을 수 없다면, 요청은 거절된다. 402 아무것도 실행되기 전에 오류는 어느 균형이 짧은지, 요청이 필요로하는 sats가 얼마나 많고 얼마나 많은 것이 무료인지 알려줍니다. max_tokens 덜 견디는 것을 의미한다.
• 실패를 실패한 요청은 공급자가 실패하기 전에 수행 한 작업에 대해 청구하지 않거나 웹 검색 또는 nymbot/auto 작업 체크가 이미 실행되었을 때, 그것은 당신이 지불하는 것입니다, 적어도 0.05 크레딧.당신이 잘라낸 스트림은 공급자가보고하는 토큰에 대해 청구됩니다 : Nymbot은 당신이 그 계산을 얻기 위해 떠난 후 25 초까지 공급자의 스트림을 계속 읽습니다.
• WEB 검색 $0.008 검색, sats로 변환, 검색이 실행되면 모델이 응답하거나 실패하든, 모델이 읽는 페이지는 또한 모델에 입력으로 전송되므로 토큰을 추가합니다.

각 응답은 비용을 말합니다.JSON 응답은 nymbot 그것이 지불 된 잔액, 크레딧과 sats의 요금과 남아있는 것과 객체 :

상품명 Cost Object

"nymbot": {
  "balance": "pro",
  "charged_credits": 0.162,
  "charged_sats": 16.2,
  "balance_credits": 412.425,
  "balance_sats": 41242.5
}

지불된 응답에는 다음과 같은 헤더가 포함되어 있습니다.Payed responses also carry these headers, which is where to look for the cost of a response that is not JSON, such as speech:

수백만 토큰당 요금, 이미 수수료와 마진을 포함하여, 모델 리스트 달러와 금액, 그리고 가격표 The Price Sheet비트코인 가격을 읽을 수 없다면 지불 요청이 반환됩니다. 503 price_unavailable 와 Retry-After: 60 추측하는 것보다는

실수

모든 오류는 OpenAI 클라이언트가 이미 이해하는 동일한 모양을 가지고 있습니다. code 당신이 맞을 수있는 안정적인 이름입니다; message 사람을 위한 것이고, 변할 수도 있다.

잘못된 몸매

{
  "error": {
    "message": "This request needs up to 200 sats (2 credits) on your Pro balance, and 40 sats are free. Catalog models spend the Pro balance. Top up in the Nymbot app or with POST /api/v1/topup/create/btc-lightning.",
    "type": "insufficient_quota",
    "code": "insufficient_balance",
    "param": null,
    "balance": "pro",
    "required_sats": 200,
    "balance_sats": 40
  }
}

두 가지 예외:

• /api/v1/messages Anthropic의 오류 형식으로 응답, 이것이 Anthropic 클라이언트가 분석하는 것이기 때문에: {"type": "error", "error": {"type": "authentication_error", "message": "…"}}종류는 상태를 따릅니다: The type follows the status: invalid_request_error, authentication_error, billing_error (402), permission_error, not_found_error, request_too_large, rate_limit_error, api_error 또는 overloaded_error (503).
• 첫 바이트 이전에 실패한 스트리밍 요청은 이벤트 스트림이 아닌 위의 상태로 일반 JSON 오류가 발생합니다.A failure after the stream has started is sent as the stream's last event, in that endpoint's own format.

오류 메시지에는 다른 서비스의 내부 세부 사항이 결코 포함되어 있지 않습니다.A provider's own error is reworded before it reaches you.

제한

사진에 대한 링크는 공공 호스트를 가리키어야 합니다: 개인 또는 로컬 네트워크 또는 Nymbot의 자신의 사이트에서 주소가 거부됩니다.Provider pacing은 앱에서 적용되며 여기서도 적용되므로 한 공급자에 대한 요청의 폭발은 실패하는 대신 느려질 수 있습니다.

화재가 볼 수 있는 것

API는 앱의 방식대로 사적인 것이 아니며, 어떻게 하는지에 대해 정확히 말할 가치가 있습니다.

• 그것은 끝에서 끝까지 암호화되지 않습니다. 앱에서 메시지는 Nymbot만이 보유하고 여행하는 키로 장치에 봉인됩니다.In the apps, a message is sealed on your device to keys only Nymbot holds and travels as a 선물 WrapAPI 요청은 일반 HTTPS입니다: 그것은 Nymbot로 가는 길에 암호화되고, Nymbot의 서버는 그것을 처리하기 위해 그것을 읽습니다.
• 서류 및 응답은 저장되지 않습니다. 그들은 모델로 통과하고 대답은 돌아갑니다.그것은 청구서입니다 : 각 요청에 대한 시간, 모델, 종류, 토큰 계산, 비용, 균형, 열쇠 및 그것이 성공했는지 여부, 90 일 동안, 그것은 무엇입니까 원하는 역사 동일한 요청의 사용 기록 (시간, 유형, 모델, 토큰 계산, 비용, 기간 및 웹 검색을 사용했는지 성공했는지 여부)은 앱 자체와 함께 90일 동안 보관됩니다.
• 나머지 모든 것이 니임을위한 것이 작고 여기에 나열되어 있습니다. API 키 해시로 저장되며, 결코 키, 이름, 짧은 힌트, 지출 캡, 재설정 기간, 만료일 및 만료일 및 마지막으로 사용되었을 때; 최신 50개의 철회된 키만 보관됩니다. 자동 TOP-UP 비디오 작업은 24 시간 동안 보관됩니다. 통화 당 지불 요청은 7 일 동안 Lightning 지불 해시 만 남기고 30 일 동안 해시 된 환불 토큰은 아무것도 연결되지 않습니다. 잔액을 덮을 수없는 요금은 상위가 지불 할 때까지 지불됩니다.
• 앱을 삭제하면 삭제됩니다.Wipe the app deletes it. A 장치 Wipe 모든 API 키를 취소 및 삭제하고 쿼리 기록, 사용 기록, 지갑 연결 및 비디오 작업을 삭제합니다.The balance and any charges still owed remain on the nym.
• 모델의 공급자는 귀하의 요청을 볼 수 있습니다.카탈로그 모델은 제작자에서 실행되며, 표준 경로 및 삽입은 Cloudflare에서 실행됩니다.
• 생성된 미디어는 공공이다. 링크로 전달된 사진과 비디오는 공개 Blossom 파일 호스트에 업로드되며, 파일의 주소는 해시 주소입니다. 링크가 있는 모든 사용자는 링크를 열 수 있으며 Nymbot은 다시 다운로드할 수 없습니다. b64_json 그리고 생성된 이미지는 응답에서 반환되며 결코 업로드되지 않습니다.
• 그래서 당신이 생성기를 제공하는 사진입니다. 당신이 업로드하는 사진 에디, 또는 A로 보내기 data: Generator의 URL image_url, 먼저 공공 Blossom 호스트에 업로드되므로 생성기는 그것을 가져올 수 있으며, 동일한 것이 적용됩니다. https:// 채팅 요청에 있는 사진은 모델의 공급자에게, Blossom에게가 아닙니다.
• 열쇠는 당신의 nym에 연결되어 있습니다. 키가 지출하는 모든 것은 귀하의 짐의 균형에서 나온다, 그래서 API 사용은 익명당신이 당신의 일상적인 니미에서 API 사용을 유지하고 싶다면, 자신의 균형을 가진 별도의 니미에서 키를 만듭니다.

앱의 보호가 필요한 경우 앱을 사용합니다.API는 자신의 도구에서 모델을 필요로 할 때 사용됩니다.

모든 Endpoint

“Nym”는 귀하의 Nostr 키에 의해 서명된 요청을 의미합니다. 계좌 서명 요청이미 이러한 형식을 말하는 도구에 대한 경우, 참조 도구 및 SDK, 그리고 Claude Code, Codex 및 Cline와 같은 코딩 에이전트에 대해서는 코딩 도구.