> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sunra.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a response
OpenAI Responses APIフォーマットを使用して、ストリーミングまたは非ストリーミングのレスポンスを作成します。
## 認証
Bearerトークン。APIキーをAuthorizationヘッダーのBearerトークンとして使用してください。
Format: `Bearer `
## リクエスト
このエンドポイントはJSONオブジェクトを受け付けます。
レスポンス生成に使用するモデルID。利用可能なモデルは [sunra.ai/models](https://sunra.ai/models) で確認できます。
レスポンスリクエストの入力。文字列または入力アイテムの配列を指定できます。
入力アイテムのタイプ。サポートされている値: `message`, `item_reference`。
メッセージ作成者のロール。サポートされている値: `user`, `assistant`, `system`。
入力メッセージの内容。文字列またはコンテンツパーツの配列を指定できます。
アイテムのID。会話履歴内の`assistant`メッセージに必須です。
アイテムのステータス。会話履歴内の`assistant`メッセージに必須です。
モデルのコンテキストの最初のアイテムとしてシステム（または開発者）メッセージを挿入します。`input`と共に使用する場合、instructionsは入力の先頭に挿入されます。
`true`に設定すると、サーバー送信イベント（SSE）を使用してレスポンスがストリーミングされます。
可視出力トークンと推論トークンを含む、出力トークン数の上限。
0から2の間のサンプリング温度。値が高いほどランダム性が増加します。
核サンプリングパラメータ。temperatureによるサンプリングの代替です。
-2.0から2.0の間の数値。正の値は、テキスト中の既存の頻度に基づいて新しいトークンにペナルティを課します。
-2.0から2.0の間の数値。正の値は、テキスト中に既に出現しているかどうかに基づいて新しいトークンにペナルティを課します。
モデルが呼び出す可能性のあるツールの配列。
ツールのタイプ。サポートされている値: `function`, `web_search_preview`。
関数の名前。typeが`function`の場合に必須です。
関数の説明。
関数パラメータを定義するJSONスキーマオブジェクト。
厳密なスキーマ準拠を有効にするかどうか。
ツール選択の動作を制御します。サポートされている文字列値: `none`, `auto`, `required`。特定の関数を指定することもできます。
モデルがツール呼び出しを並列に実行することを許可するかどうか。
テキストレスポンスフォーマットの設定。
テキストフォーマットの設定。
フォーマットタイプ。サポートされている値: `text`, `json_object`, `json_schema`。
レスポンスフォーマットの名前。typeが`json_schema`の場合に必須です。
JSONスキーマ。typeが`json_schema`の場合に必須です。
厳密なスキーマ準拠を有効にするかどうか。
推論出力の設定。
推論の労力を制約します。サポートされている値: `low`, `medium`, `high`。
生成されたレスポンスを後で取得するために保存するかどうか。
レスポンスに添付できる16個のキーと値のペアのセット。キーは最大64文字の文字列です。値は最大512文字の文字列です。
エンドユーザーを表す一意の識別子。最大128文字。
## レスポンス
成功レスポンスオブジェクト。
一意のレスポンス識別子。
オブジェクトタイプ。常に`response`。
レスポンスが作成された時のUnixタイムスタンプ（秒単位）。
レスポンスのステータス。可能な値: `completed`, `failed`, `in_progress`, `cancelled`。
レスポンス生成に使用されたモデル。
モデルによって生成されたコンテンツアイテムの配列。
出力アイテムのタイプ。例: `message`。
出力アイテムの一意のID。
ロール。常に`assistant`。
メッセージのステータス。例: `completed`。
出力メッセージの内容。
コンテンツタイプ。例: `output_text`。
生成されたテキストコンテンツ。
コンテンツのアノテーション（例: ウェブ検索からの引用）。
レスポンスのトークン使用統計。
入力トークン数。
出力トークン数。
合計トークン数。
入力トークンの内訳。
キャッシュされたトークン数。
出力トークンの内訳。
推論トークン数。
使用されたサンプリング温度。
使用された核サンプリング値。
使用された最大出力トークン設定。
生成が失敗した場合のエラーオブジェクト。
```bash cURL theme={null}
curl -X POST https://api-llm.sunra.ai/v1/responses \
-H "Authorization: Bearer " \
-H "Content-Type: application/json" \
-d '{
"model": "openai/gpt-4o",
"input": [
{
"type": "message",
"role": "user",
"content": "Hello, how are you?"
}
]
}'
```
```python Python theme={null}
import requests
response = requests.post(
"https://api-llm.sunra.ai/v1/responses",
headers={
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
json={
"model": "openai/gpt-4o",
"input": [
{
"type": "message",
"role": "user",
"content": "Hello, how are you?"
}
]
}
)
print(response.json())
```
```javascript JavaScript theme={null}
const response = await fetch("https://api-llm.sunra.ai/v1/responses", {
method: "POST",
headers: {
"Authorization": "Bearer ",
"Content-Type": "application/json"
},
body: JSON.stringify({
model: "openai/gpt-4o",
input: [
{
type: "message",
role: "user",
content: "Hello, how are you?"
}
]
})
});
const data = await response.json();
console.log(data);
```
```json 200 theme={null}
{
"id": "resp-abc123",
"object": "response",
"created_at": 1704067200,
"status": "completed",
"model": "openai/gpt-4o",
"output": [
{
"type": "message",
"id": "msg_abc123",
"role": "assistant",
"status": "completed",
"content": [
{
"type": "output_text",
"text": "Hello! I'm doing well, thank you for asking. How can I help you today?",
"annotations": []
}
]
}
],
"temperature": 1.0,
"top_p": 1.0,
"max_output_tokens": null,
"usage": {
"input_tokens": 15,
"output_tokens": 18,
"total_tokens": 33,
"input_tokens_details": {
"cached_tokens": 0
},
"output_tokens_details": {
"reasoning_tokens": 0
}
},
"error": null
}
```