ひと目でわかる

このドキュメントはCLEVI開発者ドキュメントの出発点です。Clevi-X-Platformの構成、APIで呼び出せる2つのモデル、認証方式、リクエストとレスポンスの形式をまとめて説明します。リクエストとレスポンスはOpenAI Chat Completions形式に従っているため、既存のOpenAI SDKではbase_urlとapi_keyの2つの値を変更するだけで接続できます。インストールなしで最初の呼び出しまで進める手順はQuick Startドキュメントにあります。

プラットフォーム構成

Clevi-X-Platformは、モデル、エージェント、セマンティックデータベース、フィジカルAIを1つの実行環境に配置します。このうち、開発者が現在HTTPで直接呼び出せるのはモデル層です。その他の層はプラットフォーム内部とコンソールで動作し、公開APIの範囲は以下の表に示すとおりです。

モデルラインアップ

リクエスト本文のmodelフィールドに、以下の2つの名前のいずれかをそのまま入力します。2つのモデルは同じアドレス、同じ認証、同じリクエスト形式を使用します。

• cip-5.5-im
• cip-5.5-mm

cip-5.5-im

文書、画像、図面、業務データを意味単位でつなぎ、検索結果と知識構造を作ります。Physical AI の計画策定と再計画の段階で入力を解釈する際にも、同じモデルを使います。内部識別子には RB-IM が使われ、API では cip-5.5-im のみが有効な名前です。

cip-5.5-mm

テキストと画像、さらに複数の文書にまたがる複合的なコンテキストをまとめて読み取り、回答を生成します。ツール呼び出しや業務フローの実行を含む Agentic な作業に合わせて調整されたモデルです。

モデルを選ぶ

その他のモデル

プラットフォームには以下のモデルもあります。デプロイ形態とアクセス経路がそれぞれ異なるため、公開 API 名は別途ご案内します。

基本情報と認証

キーはワークスペース単位で発行し、リクエストごとに Authorization ヘッダーへ Bearer として付与します。以下の表にある6つの値を設定すれば、初回呼び出しに必要な準備は完了です。

表と例の sk-... は発行されたキーを入力する場所です。以下のコマンドで環境変数に設定しておくと、このドキュメントの例をそのままコピーして実行できます。

export CLEVI_API_KEY="sk-..."

POST /api/services/v1/aiservice/openai/v1/chat/completions

メッセージ配列とモデル名を受け取り、モデルが生成した1つのメッセージを choices 配列に含めて返します。完全なアドレスは https://platform.clevi.net/api/services/v1/aiservice/openai/v1/chat/completions です。messages には少なくとも1つのメッセージオブジェクトを含める必要があり、各オブジェクトは role と content を持ちます。

curl https://platform.clevi.net/api/services/v1/aiservice/openai/v1/chat/completions \
  -H "Authorization: Bearer $CLEVI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "cip-5.5-mm",
    "messages": [
      {"role": "system", "content": "사내 문서를 요약하는 도우미로 답한다."},
      {"role": "user", "content": "이 API 의 인증 방식을 한 문장으로 설명해 줘."}
    ]
  }'

# pip install openai
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["CLEVI_API_KEY"],
    base_url="https://platform.clevi.net/api/services/v1/aiservice/openai/v1",
)

completion = client.chat.completions.create(
    model="cip-5.5-mm",
    messages=[
        {"role": "system", "content": "사내 문서를 요약하는 도우미로 답한다."},
        {"role": "user", "content": "이 API 의 인증 방식을 한 문장으로 설명해 줘."},
    ],
)

print(completion.choices[0].message.content)

// npm install openai
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.CLEVI_API_KEY,
  baseURL: "https://platform.clevi.net/api/services/v1/aiservice/openai/v1",
});

const completion = await client.chat.completions.create({
  model: "cip-5.5-mm",
  messages: [
    { role: "system", content: "사내 문서를 요약하는 도우미로 답한다." },
    { role: "user", content: "이 API 의 인증 방식을 한 문장으로 설명해 줘." },
  ],
});

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

{
  "id": "chatcmpl-7d21b4e0",
  "object": "chat.completion",
  "created": 1755500000,
  "model": "cip-5.5-mm",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Authorization 헤더에 Bearer 와 발급받은 API 키를 넣어 인증합니다."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 38,
    "completion_tokens": 24,
    "total_tokens": 62
  }
}

レスポンスフィールド

レスポンスは最上位フィールド6つで構成されます。生成された文章は choices 配列の最初の要素内にあり、トークン使用量は usage にあります。

エラー

失敗したリクエストは HTTP ステータスコードで原因を知らせます。まず以下の対処を確認し、同じコードが繰り返される場合はレスポンスの id とリクエスト時刻を記録しておいてください。

デプロイ形態

同じモデルをクラウド API とオンプレミスインストールの2種類で使用します。リクエスト形式と認証方式はどちらの場合も同じですが、URL とキー管理画面が異なります。

データガバナンス

プラットフォームでは、以下の4つを基本動作としています。ワークスペースを分ける基準を決める際に、あわせて確認してください。

• 権限ベースの制御 — ワークスペース単位でアクセス権限とキーを分けます。
• 隔離された作業領域 — ワークスペース間でデータが混在しません。
• リアルタイムデータ接続 — 外部システムと接続したデータを、参照時点で取得します。
• プロセスごとの記録保持 — 実行した作業単位で記録を残します。

開始手順

初めて接続する場合は、以下の手順で進めてください。3番まで完了すると、1つのキーで両方のモデルを呼び出せます。

1. https://platform.clevi.net/account/login でログインまたはアカウントを作成します。
2. https://clevi.app/cloud でワークスペースを追加します。
3. https://clevi.app/cloud/keys でキーを発行し、環境変数に保存します。
4. https://clevi.app/cloud/playground で cip-5.5-im と cip-5.5-mm の応答を比較します。
5. Quick Start ドキュメントのリクエスト例をコピーして、最初の呼び出しを送信します。

ワークスペースを作成

APIキーを発行

プレイグラウンドを開く