> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tokenlab.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAI SDK

> 公式のOpenAI SDKおよびOpenAI互換クライアントでTokenLabを使用する

## 概要

TokenLabはクライアントのbase URLを`https://api.tokenlab.sh/v1`にポイントすることで公式のOpenAI SDKと連携します。

ほとんどの新規プロジェクトでは、デフォルトのOpenAI互換パスとして**Chat Completions**を使用することを推奨します。**Responses API**は、Responses固有の動作が明確に必要な場合にのみ使用してください。

Responses固有のフィールドは、すべてのモデルやルーティング経路で同一に動作することは保証されません。

<Note>
  Python、JavaScript、Goには公式のOpenAI SDKがあります。PHPはOpenAI互換のコミュニティ製クライアントと相性が良いですが、公式のOpenAI SDKではありません。
</Note>

<Note>
  **タイプ**: ネイティブSDK

  **主要経路**: OpenAI互換 / Chat Completions

  **サポート状況**: コア経路としてサポートされています
</Note>

## インストール

<CodeGroup>
  ```bash Python theme={null}
  pip install openai
  ```

  ```bash JavaScript theme={null}
  npm install openai
  ```

  ```bash Go theme={null}
  go get github.com/openai/openai-go/v3
  ```
</CodeGroup>

<Note>
  `POST /v1/responses`はResponses固有の動作が明確に必要な場合にのみ使用してください。Responses専用の一部フィールドは選択したモデルやルーティング経路に依存する場合があります。
</Note>

## クライアントの設定

<CodeGroup>
  ```python Python theme={null}
  from openai import OpenAI

  client = OpenAI(
      api_key="sk-your-tokenlab-key",
      base_url="https://api.tokenlab.sh/v1",
  )
  ```

  ```javascript JavaScript theme={null}
  import OpenAI from 'openai';

  const client = new OpenAI({
    apiKey: 'sk-your-tokenlab-key',
    baseURL: 'https://api.tokenlab.sh/v1',
  });
  ```

  ```go Go theme={null}
  package main

  import (
      openai "github.com/openai/openai-go/v3"
      "github.com/openai/openai-go/v3/option"
  )

  func main() {
      client := openai.NewClient(
          option.WithAPIKey("sk-your-tokenlab-key"),
          option.WithBaseURL("https://api.tokenlab.sh/v1"),
      )

      _ = client
  }
  ```
</CodeGroup>

## 推奨: Chat Completions

<CodeGroup>
  ```python Python theme={null}
  response = client.chat.completions.create(
      model="gpt-5.4",
      messages=[{"role": "user", "content": "Explain what TokenLab does in one sentence."}]
  )

  print(response.choices[0].message.content)
  ```

  ```javascript JavaScript theme={null}
  const response = await client.chat.completions.create({
    model: 'gpt-5.4',
    messages: [{ role: 'user', content: 'Explain what TokenLab does in one sentence.' }],
  });

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

  ```bash cURL theme={null}
  curl https://api.tokenlab.sh/v1/chat/completions \
    -H "Authorization: Bearer sk-your-tokenlab-key" \
    -H "Content-Type: application/json" \
    -d '{
      "model": "gpt-5.4",
      "messages": [
        {"role": "user", "content": "Explain what TokenLab does in one sentence."}
      ]
    }'
  ```
</CodeGroup>

## 高度な使用法: Responses API

この経路は、ツールやワークフローが明確にOpenAI Responsesのセマンティクスに依存している場合にのみ使用してください。

### Responsesでのストリーミング

<CodeGroup>
  ```python Python theme={null}
  stream = client.responses.create(
      model="gpt-5.4",
      input="Write a short poem about coding.",
      stream=True,
  )

  for event in stream:
      if event.type == "response.output_text.delta":
          print(event.delta, end="")
  ```

  ```javascript JavaScript theme={null}
  const stream = await client.responses.create({
    model: 'gpt-5.4',
    input: 'Write a short poem about coding.',
    stream: true,
  });

  for await (const event of stream) {
    if (event.type === 'response.output_text.delta') {
      process.stdout.write(event.delta);
    }
  }
  ```
</CodeGroup>

## ツール / 関数呼び出し

```python theme={null}
response = client.responses.create(
    model="gpt-5.4",
    input="What's the weather in Tokyo?",
    tools=[{
        "type": "function",
        "name": "get_weather",
        "description": "Get weather for a location",
        "parameters": {
            "type": "object",
            "properties": {
                "location": {"type": "string"}
            },
            "required": ["location"]
        }
    }]
)

for item in response.output:
    if item.type == "function_call":
        print(item.name)
        print(item.arguments)
```

## ResponsesでのVision

```python theme={null}
response = client.responses.create(
    model="gpt-4o",
    input=[{
        "role": "user",
        "content": [
            {"type": "input_text", "text": "What's in this image?"},
            {"type": "input_image", "image_url": "https://example.com/image.jpg"}
        ]
    }]
)

print(response.output_text)
```

## 埋め込み

```python theme={null}
response = client.embeddings.create(
    model="text-embedding-3-small",
    input="Hello world"
)

print(response.data[0].embedding[:5])
```

## Chat Completions

Chat CompletionsはTokenLabのデフォルトのOpenAI互換パスです:

```python theme={null}
response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello!"}
    ]
)

print(response.choices[0].message.content)
```

## トラブルシューティング

<AccordionGroup>
  <Accordion title="接続エラー">
    * ベースURLが正確に `https://api.tokenlab.sh/v1` になっていることを確認してください
    * プロキシの干渉やカスタムHTTPクライアントのオーバーライドがないか確認してください
    * プロバイダの動作をデバッグする前にSDKのバージョンが最新であることを確認してください
  </Accordion>

  <Accordion title="認証エラー">
    * APIキーが `sk-` で始まっていることを確認してください
    * TokenLabダッシュボードでキーが有効であることを確認してください
    * SDKが `Authorization: Bearer ...` を送信していることを確認してください
  </Accordion>

  <Accordion title="APIパスが間違っている">
    * `responses.create(...)` は `/v1/responses` にリクエストを送信します
    * `chat.completions.create(...)` は `/v1/chat/completions` にリクエストを送信します
    * Responses固有の動作が明確に必要な場合を除き、デフォルトでは Chat Completions を使用してください
  </Accordion>
</AccordionGroup>
