OpenAPI 3.1

سەرچاوەی APIی کڕیار

ئەم لاپەڕەیە داواکاری و وەڵامی inferenceی پشتگیریکراوی کڕیار ڕوون دەکاتەوە. بۆ ئامرازەکان، بەڵگەنامەی OpenAPIی خوێندنەوەی ماشینی دابەزێنە.

دابەزاندنی JSONی OpenAPI

نموونەکانی APIی مۆدێل

ناسێنەری مۆدێلی بڵاوکراوە، پرۆتۆکۆلی API و زمان هەڵبژێرە بۆ بینینی نموونەی داواکاری. کلیلی APIی کڕیار لە ڕاژەخزمەتێکی متمانەپێکراودا بهێڵەوە.

مۆدێل

زمان

پێداویستییەکانی پرۆتۆکۆل

داواکارییە گونجاوەکانی OpenAI، POST /chat/completions لە URLی بنەمای APIی کڕیار بەکاردەهێنن کە ڕێکخراوە (بنەڕەت: https://fusionpointai.com/api/v1). بە Authorization: Bearer پشتڕاست بکەرەوە و کلیلی کڕیارێک بە دەستگەیشتنی inference بەکاربهێنە. URLی بنەڕەتیی تەواو https://fusionpointai.com/api/v1/chat/completionsە.

توانا پشتگیریکراوەکان

خاڵی کۆتاییی چاتی گونجاو لەگەڵ OpenAI نامەی دەقیی هاوکات مامەڵەی لەگەڵ دەکات. ئەم خاڵە کۆتاییە پشتگیریی streaming و بانگکردنی ئامراز ناکات.

دامەزراندنی کڕیار

کڕیارەکانی Python و Node.js وەک پاکێجی جیاواز دابمەزرێنە:

Python: pip install openai anthropic

Node.js: npm install openai @anthropic-ai/sdk

curl 'https://fusionpointai.com/api/v1/chat/completions' \
  -H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "gpt-6.1-sol",
    "messages": [
        {
            "role": "user",
            "content": "Summarize this in one sentence."
        }
    ],
    "temperature": 0.7,
    "max_tokens": 300
}'

شێوازی داواکاری

ڕێکخستنی پارێزراوی کلیلی API

کلیلی APIی کڕیارێک بە دەستگەیشتنی inference دروست بکە و لە ڕێگەی بەڕێوەبەری نهێنی یان ژینگەوە بیدە بە پرۆسەیەکی ڕاژەخزمەت.

FUSIONPOINTAI_API_KEY لە ژینگەی ڕاژەخزمەت دابنێ؛ کلیلی لە کۆدی وێبگەڕدا دانەنێ یان لە کۆنترۆڵی وەشان تۆماری مەکە.
HTTPS بەکاربهێنە و کلیلەکە بە هەژمار و مۆڵەتی inferenceی پێویستی بەرنامەکە سنووردار بکە.
سەردێڕەکانی authorization و x-api-key لە تۆمار، trace و داواکاریی پشتگیری لاببە؛ ئەگەر لەوانەیە کلیل ئاشکرا بووبێت، ڕەتی بکەرەوە.

export FUSIONPOINTAI_API_KEY="YOUR_CUSTOMER_API_KEY"

هەڵبژاردنی ناسێنەری وردی مۆدێل

خانەی مۆدێل بەهای ڕەوانەکردنە، نەک ناوی پیشاندان. ناسێنەرێک هەڵبژێرە کە لە کەتەلۆگی زیندووی مۆدێل بڵاوکراوەتەوە.

مۆدێلێکی چالاک یان کۆن هەڵبژێرە کە بۆ inference بەردەست نیشانکراوە.
ناسێنەرەکە بە وردی لەگەڵ خاڵبەندی و پاشگری وەشانەکان لەبەر بگرە؛ هەرگیز ناسێنەرێک لە ناوی مۆدێل دروست مەکە.
ئەگەر ناسێنەرێک بڵاو نەکراوەتەوە، چاوەڕێی کەتەلۆگ بکە تا دابینی بکات؛ بەهای خەمڵێنراو جێگرەوە مەکە.

model_id = "gpt-6.1-sol"
# Use this exact identifier with either protocol.

ناردنی نامەی سیستەم و نامەی چەندجارە

ڕیزبەندیی قۆناغەکانی گفتوگۆ وەک خۆی بهێڵەوە و تەنها ئەو ڕۆڵ و شێوەی ناوەڕۆکە بەکاربهێنە کە پرۆتۆکۆل و مۆدێلی هەڵبژێردراو پشتگیری دەکەن.

بۆ داواکاریی گونجاو لەگەڵ OpenAI، نامەی system، user و assistant وەک خانەی ناوەڕۆکی دەقیی ڕیزبەندکراو بنێرە.
بۆ Claude Messages، ڕێنماییی سیستەمی پشتگیریکراو و قۆناغە ڕیزبەندکراوەکانی user/assistant لە خانە سروشتییەکانی پرۆتۆکۆلدا بنێرە.
تەنها ئەو کۆنتێکستی گفتوگۆ بهێڵەوە کە بەرنامەکەت پێویستی پێیەتی و سنووری کۆنتێکستی مۆدێلی هەڵبژێردراو پەیڕەو بکە.

response = client.messages.create(
    model="gpt-6.1-sol",
    max_tokens=512,
    system="Answer in clear, concise German.",
    messages=[
        {"role": "user", "content": "What is an API?"},
        {"role": "assistant", "content": "An API lets software exchange requests and responses."},
        {"role": "user", "content": "Give a practical example."},
    ],
)
for block in response.content:
    if block.type == "text":
        print(block.text)

داوای وەڵامی JSON

کاتێک بەرنامە دەرئەنجامی ڕێکخراوی دەوێت، پێش بەکارهێنانی وەڵامەکە بە schemaی خۆی هەڵیبسەنگێنە.

کۆنترۆڵی دەرخستنی ڕێکخراوی پشتگیریکراو لەلایەن پرۆتۆکۆل و مۆدێلی upstreamی هەڵبژێردراو بەکاربهێنە.
JSONی دروستکراو وەک تێخستنی متمانەپێنەکراو مامەڵەی لەگەڵ بکە: parseی بکە، خانە و جۆرە پێویستەکان پشتڕاست بکەوە و بۆ دەرخستنی نادروست ئامادەبە.
گریمانە مەکە تێکەڵەیەکی مۆدێل و پرۆتۆکۆل دۆخی JSON پشتگیری دەکات، مەگەر بەڵگەنامەی مۆدێل بیڵێت.

import json

# JSON is generated content, not trusted application input.
response = client.messages.create(
    model="gpt-6.1-sol", max_tokens=256,
    messages=[{"role": "user", "content": 'Return only JSON with a string field named "summary". Explain an API in one sentence.'}],
)
text = "".join(block.text for block in response.content if block.type == "text")
try:
    result = json.loads(text)
    if not isinstance(result, dict) or not isinstance(result.get("summary"), str):
        raise ValueError("Unexpected response schema")
    print(result["summary"])
except (json.JSONDecodeError, ValueError) as error:
    print("Handle invalid model output:", error)

وەرگرتنی دەرخستنی SSEی ڕاستەوخۆ

ڕەفتاری streaming بە پرۆتۆکۆل و مۆدێلی upstreamی هەڵبژێردراوەوە بەستراوە؛ وەڵامی ئاساییی JSON streaming نییە.

چاتی گونجاو لەگەڵ OpenAI لە ئێستادا دەقی هاوکات دەگەڕێنێتەوە و streaming پێشکەش ناکات.
بۆ Claude Messages، ئەگەر مۆدێلی upstream پشتگیریی بکات دۆخی stream بەکاربهێنە؛ پرۆکسییەکە server-sent eventی سروشتی دەنێرێتەوە.
ڕووداوەکان هەنگاو بە هەنگاو وەربگرە، لە کۆتایی یان هەڵە بە پاکی بوەستە و دەرخستنی بەشەکی بە وەڵامی تەواو مەزانە.

# client is the Anthropic client configured above.
with client.messages.stream(
    model="gpt-6.1-sol", max_tokens=512,
    messages=[{"role": "user", "content": "Explain API authentication."}],
) as stream:
    for text in stream.text_stream:
        print(text, end="", flush=True)
    final_message = stream.get_final_message()
print("\nStop reason:", final_message.stop_reason)

مامەڵە لەگەڵ ئامراز، بلۆکی ناوەڕۆک و هەڵەکان

پێکهاتە سروشتییەکانی پرۆتۆکۆل بپارێزە و ڕەفتاری بەرنامە لە بەرامبەر بانگکردنی ئامراز، ناوەڕۆکی چەندڕەنگ و شکسته‌کاندا بە ڕوونی دیاری بکە.

چاتی گونجاو لەگەڵ OpenAI لە ئێستادا نە بانگکردنی ئامراز پشتگیری دەکات و نە بلۆکی ناوەڕۆکی نادەقی.
Claude بلۆکی ناوەڕۆکی سروشتی و داتای بەکارهێنان/ئەنجامی ئامراز دەپارێزێت ئەگەر مۆدێلی upstream پشتگیریی بکات؛ پێش جێبەجێکردن ناوی ئامراز و ئارگومێنتەکان پشتڕاست بکەرەوە.
دۆخی HTTP و ناوەڕۆکی وەڵام بپشکنە، شکستەکانی پشتڕاستکردنەوە، مۆڵەت، پشتڕاستکردنەوەی خانە و سنووری ڕێژە لە یەک جیا بکەرەوە و بۆ هەڵەی کاتی دووبارە هەوڵ بدەرەوە بە دواخستنی زیادبوو.

import json
from datetime import datetime, timezone
from anthropic import APIError

messages = [{"role": "user", "content": "What time is it in UTC?"}]
tools = [{
    "name": "current_utc_time", "description": "Read the current UTC time.",
    "input_schema": {"type": "object", "properties": {}, "additionalProperties": False},
}]
try:
    reply = client.messages.create(model="gpt-6.1-sol", max_tokens=256, messages=messages, tools=tools)
    results = []
    for block in reply.content:
        if block.type == "tool_use":
            if block.name != "current_utc_time" or block.input != {}:
                raise ValueError("Unapproved tool request")
            results.append({"type": "tool_result", "tool_use_id": block.id,
                            "content": json.dumps({"utc": datetime.now(timezone.utc).isoformat()})})
    if results:
        messages.append({"role": "assistant", "content": reply.content})
        messages.append({"role": "user", "content": results})
        reply = client.messages.create(model="gpt-6.1-sol", max_tokens=256, messages=messages, tools=tools)
    print("".join(block.text for block in reply.content if block.type == "text"))
except APIError as error:
    # Log status only; never log keys or private prompts.
    print("API request failed:", getattr(error, "status_code", None))

پرسیارە باوەکان

دەتوانم ناوی پیشاندانی مۆدێل لە داواکاری بەکاربهێنم؟

تەنها ناسێنەری وردی بڵاوکراوە بۆ inference بەکاربهێنە. ناوی پیشاندان بەهای ڕەوانەکردن نییە و ناسێنەری بڵاونەکراوە هەرگیز نابێت خەمڵێنرێت.

کلیلی کڕیار لە کام ژینگەگۆڕاوەدا هەڵدەگیرێت؟

بۆ هەردوو پرۆتۆکۆل FUSIONPOINTAI_API_KEY بەکاربهێنە. بەهای کلیل لە ژینگەی ڕاژەخزمەتی متمانەپێکراودا بهێڵەوە و لە کۆدی لای کڕیار و تۆمار دووری بخەرەوە.

کڕیاری OpenAI کام URL بەکاربهێنێت؟

URLی بنەمای APIی کڕیاری ڕێکخراو بەکاربهێنە کە بنەڕەتەکەی https://fusionpointai.com/api/v1ە. خاڵی کۆتاییی chat-completions، /chat/completionsی پێوە زیاد دەکات.

بۆچی URLی بنەمای Claude SDK لە cURL جیاوازە؟

Anthropic SDK، /v1/messages زیاد دەکات، بۆیە URLی بنەماکەی بکە بە https://fusionpointai.com/api. داواکاریی HTTPی ڕاستەوخۆ URLی تەواوی /api/v1/messages بەکاردەهێنێت.

ئایا چاتی گونجاو لەگەڵ OpenAI streaming یان ئامراز پشتگیری دەکات؟

نەخێر. خاڵی کۆتاییی ئێستا تەنها نامەی دەقیی هاوکات پشتگیری دەکات؛ streaming و بانگکردنی ئامراز لەوێدا بەردەست نین.

ئایا گەرەنتی دەکرێت هەموو مۆدێلەکانی Claude بلۆک، ئامراز یان streaming پشتگیری بکەن؟

نەخێر. ئەم تایبەتمەندییانەی سروشتی تەنها ئەگەر مۆدێلی upstreamی هەڵبژێردراو پشتگیری بکات دەپارێزرێن. توانای مۆدێلەکە بپشکنە و داواکاریی پشتگیری‌نەکراو بەڕێوەببە.

Claude Messages · `POST /messages`

داواکارییەکانی Claude Messages، POST /api/v1/messages بەکاردەهێنن. کلیلی کڕیار لە x-api-key بنێرە و anthropic-version بکە بە 2023-06-01. URLی بنەمای Anthropic SDK https://fusionpointai.com/apiیە چونکە SDK، /v1/messages زیاد دەکات؛ پشتڕاستکردنەوەی Bearerیش پشتگیری دەکرێت.

پرۆکسیی Claude Messages، بلۆکی ناوەڕۆکی سروشتی، داتای ئامراز و streamingی ڕاستەقینەی server-sent event دەپارێزێت ئەگەر مۆدێلی upstreamی هەڵبژێردراو پشتگیرییان بکات.

خانە	جۆر	پێویستە	سنوورەکان
`model`	`string`	بەڵێ	`{"minLength":1,"maxLength":160}`
`max_tokens`	`integer`	بەڵێ	`{"minimum":1,"maximum":100000}`
`messages`	`array`	بەڵێ	`{"minItems":1,"maxItems":100,"items":{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","maxLength":80}},"additionalProperties":true}}]}}}}`
`system`	`string \| array`	نەخێر	`{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"object","required":["type","text"],"properties":{"type":{"const":"text"},"text":{"type":"string"}},"additionalProperties":true}}]}`
`stream`	`boolean`	نەخێر	`{"default":false}`
`temperature`	`number`	نەخێر	`{"minimum":0,"maximum":1}`
`top_p`	`number`	نەخێر	`{"minimum":0,"maximum":1}`
`top_k`	`integer`	نەخێر	`{"minimum":0,"maximum":100000}`
`stop_sequences`	`array`	نەخێر	`{"items":{"type":"string"}}`
`tools`	`array`	نەخێر	`{"items":{"type":"object","additionalProperties":true}}`
`tool_choice`	`object`	نەخێر	`{"additionalProperties":true}`
`thinking`	`object`	نەخێر	`{"additionalProperties":true}`
`metadata`	`object`	نەخێر	`{"additionalProperties":true}`
`output_config`	`object`	نەخێر	`{"additionalProperties":true}`
`service_tier`	`string`	نەخێر	`[]`

{
    "id": "msg_example",
    "type": "message",
    "role": "assistant",
    "model": "gpt-6.1-sol",
    "content": [
        {
            "type": "text",
            "text": "A concise answer to the supplied question."
        }
    ],
    "stop_reason": "end_turn",
    "stop_sequence": null,
    "usage": {
        "input_tokens": 12,
        "output_tokens": 10
    }
}

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

دەستپێکردنی خێرای SDK

URLی بنەڕەتیی بەرهەمهێنان لەگەڵ کڕیاری Python یان Node.jsی گونجاو بەکاربهێنە، یان هەمان داواکاریی JSON بە cURL بنێرە.

URLی بنەڕەتیی API: https://fusionpointai.com/api/v1

کلیلی APIی کڕیار لە هێدەری Authorization: Bearer بنێرە. کلیلەکە دەبێت مەودای ai:inference و دەستگەیشتنی هەژمار بۆ خزمەتگوزارییەکەی هەبێت. کلیلەکە لە سێرڤەرێکی متمانەپێکراودا بهێڵەوە.

# Install the client for your application language.
# Python:
python -m pip install openai
# Node.js:
npm install openai

# Bash: enter the key without storing it in shell history.
read -rs -p 'FusionPointAI API key: ' FUSIONPOINTAI_API_KEY
export FUSIONPOINTAI_API_KEY
printf '\n'
# After finishing:
# unset FUSIONPOINTAI_API_KEY

curl 'https://fusionpointai.com/api/v1/chat/completions' \
  -H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
    "model": "claude-opus-5-5",
    "messages": [
        {
            "role": "user",
            "content": "Summarize this in one sentence."
        }
    ],
    "temperature": 0.7,
    "max_tokens": 300
}'

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FUSIONPOINTAI_API_KEY"],
    base_url="https://fusionpointai.com/api/v1",
)

response = client.chat.completions.create(
    model="claude-opus-5-5",
    messages=[{"role": "user", "content": "Summarize this in one sentence."}],
    temperature=0.7,
    max_tokens=300,
)
print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.FUSIONPOINTAI_API_KEY,
  baseURL: "https://fusionpointai.com/api/v1",
});

const response = await client.chat.completions.create({
  model: "claude-opus-5-5",
  messages: [{ role: "user", content: "Summarize this in one sentence." }],
  temperature: 0.7,
  max_tokens: 300,
});
console.log(response.choices[0].message.content);

OpenAI · خانەکانی داواکاری

بەهای مۆدێل، ناسنامە تۆمارکراوە وردەکانی ئێستای بڵاوکراوە بۆ inferenceن. ئەگەر هیچ ناسنامەیەک بڵاونەکراوەتەوە، پێش ناردنی داواکاری کاتەلۆگی دابینکەر بپشکنە.

خانە	جۆر	پێویستە	سنوورەکان
`model`	`string`	بەڵێ	زۆرترین 160 پیت؛ ناسنامەی بڵاوکراوەی ورد بەکاربهێنە.
`messages`	`array`	بەڵێ	1 تا 100 پەیام، بە ڕیز دەنێردرێن.
`messages[].role`	`string`	بەڵێ	system، user یان assistant.
`messages[].content`	`string`	بەڵێ	زۆرترین 100,000 پیت بۆ هەر پەیامێک.
`temperature`	`number`	نەخێر	لە 0 تا 2.
`max_tokens`	`integer`	نەخێر	لە 1 تا 100,000؛ ڕەنگە مۆدێل سنوورێکی کەمتر دابنێت.

وەڵامی سەرکەوتوو

وەڵامی JSONی سەرکەوتوو id، object (chat.completion)، created، model و choices دەگرێتەوە. choiceێک index، پەیامی assistant و finish_reason لەخۆدەگرێت. ڕەنگە بەکارهێنانی تۆکنیش بگەڕێندرێتەوە.

{
    "id": "chatcmpl_example",
    "object": "chat.completion",
    "created": 1700000000,
    "model": "claude-opus-5-5",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "A concise summary of the supplied text."
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 12,
        "completion_tokens": 10,
        "total_tokens": 22
    }
}

خانە	جۆر	واتا
`id`	`string`	ناسنامەی تاکی تەواوکردن.
`object`	`string`	جۆری وەڵام: chat.completion.
`created`	`integer`	کاتی دروستکردن وەک مۆرەکاتی Unix.
`model`	`string`	ناسنامەی مۆدێلی بەکارهاتوو بۆ تەواوکردن.
`choices`	`array`	هەڵبژاردەکانی تەواوکردن لەگەڵ پەیامی assistant و هۆکاری کۆتایی.
`usage`	`object`	ژمارەی تۆکنەکان، ئەگەر بگەڕێندرێتەوە.

سنووری ڕێژە و هەڵەکان

بەشداریکردنی کڕیاری چالاک داواکاری یان بەکارهێنانی تۆکن بەرامبەر کوۆتا ناپێوێت؛ کلیلی sandbox ڕێگەپێدانی مانگانەی بڵاوکراوەی خۆی بەکاردەهێنێت. پەنجەرەی کۆنتێکستی مۆدێل، سنووری دەرچوون و کۆنترۆڵی کاتیی هاتوچۆ هەروا کاریگەرن. Chat Completions دەقی هاوکاتە؛ Claude Messages بلۆکی ناوەڕۆکی سروشتی، ئامراز و SSEی پشتگیریکراو دەپارێزێت. پێش ناردنی داواکاری، سکیماکانی کرداری جیاواز بپشکنە.

کرداری chat شکستی پشتڕاستکردنەوە و دابینکەر لە ئۆبجێکتی هەڵەدا دەگەڕێنێتەوە. Middlewareی پشتڕاستکردنەوە و مەودا لەوانەیە لەبری ئەوە خانەی messageی سەرەکی بگەڕێنێتەوە؛ دۆخ و قاپ بە لایەنی ڕەتکردنەوەکەوە دەبەسترێتەوە.

دۆخی HTTP	واتا
`200`	تەواوکردن بە سەرکەوتوویی دروست کرا.
`400`	جەستە یان پارامەتەری داواکاری نادروستە.
`401`	کلیلی APIی bearer نییە یان نادروستە.
`403`	مەودای پێویستی کلیل یان دەستگەیشتنی هەژمار نییە.
`429`	throttleی بەرنامە یان کۆنترۆڵی کاتیی هاتوچۆی دابینکەری سەرەوە؛ بە دواخستن دووبارە هەوڵ بدەرەوە.
`500`	خزمەتگوزارییەکە نەیتوانی تەواوکردنێکی بەکارهێنراو بگەڕێنێتەوە.