PHP API リファレンス

メッセージ

メッセージを作成

$client->messages->create(int maxTokens, list<MessageParam> messages, Model model, ?CacheControlEphemeral cacheControl, ?MessageCreateParamsContainer container, ?DiagnosticsParam diagnostics, ?string inferenceGeo, ?Metadata metadata, ?OutputConfig outputConfig, ?ServiceTier serviceTier, ?Speed speed, ?list<string> stopSequences, ?System system, ?ThinkingConfigParam thinking, ?ToolChoice toolChoice, ?list<ToolUnion> tools, ?string userProfileID, ?string workspaceID): Message

POST/v1/messages

テキストや画像コンテンツを含む入力メッセージの構造化されたリストを送信すると、モデルが会話内の次のメッセージを生成します。

メッセージ内のトークンをカウント

$client->messages->countTokens(list<MessageParam> messages, Model model, ?CacheControlEphemeral cacheControl, ?OutputConfig outputConfig, ?Speed speed, ?System system, ?ThinkingConfigParam thinking, ?ToolChoice toolChoice, ?list<MessageCountTokensTool> tools, ?string userProfileID, ?string workspaceID): MessageTokensCount

POST/v1/messages/count_tokens

メッセージ内のトークン数をカウントします。

モデル

モデルの一覧

$client->models->list(?string afterID, ?string beforeID, ?list<Lifecycle> lifecycle, ?int limit, ?string workspaceID): Page<ModelInfo>

GET/v1/models

利用可能なモデルを一覧表示します。

モデルを取得

$client->models->retrieve(string modelID, ?string workspaceID): ModelInfo

GET/v1/models/{model_id}

特定のモデルを取得します。

ファイル

ファイルをアップロード

$client->files->upload(FileParam | string file, ?int expiresInSeconds, ?string workspaceID): FileMetadata

POST/v1/files

ファイルの一覧

$client->files->list(?list<string> ids, ?int limit, ?string page, ?string workspaceID): PageCursor<FileMetadata>

GET/v1/files

ファイルをダウンロード

$client->files->download(string fileID, ?string workspaceID): download

GET/v1/files/{file_id}/content

ファイルのメタデータを取得

$client->files->retrieveMetadata(string fileID, ?string workspaceID): FileMetadata

GET/v1/files/{file_id}

ファイルを削除

$client->files->delete(string fileID, ?string workspaceID): DeletedFile

DELETE/v1/files/{file_id}

スキル

スキルを作成

$client->skills->create(list<FileParam | string> files, ?string displayName, ?string workspaceID): Skill

POST/v1/skills

スキルの一覧

$client->skills->list(?int limit, ?string page, ?string source, ?string workspaceID): PageCursor<Skill>

GET/v1/skills

スキルを取得

$client->skills->retrieve(string skillID, ?string workspaceID): Skill

GET/v1/skills/{skill_id}

スキルを削除

$client->skills->delete(string skillID, ?string workspaceID): DeletedSkill

DELETE/v1/skills/{skill_id}

$client->userProfiles->create(?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array<string,string> metadata, ?string name, ?string workspaceID): UserProfile

POST/v1/user_profiles

ユーザープロファイルの一覧を取得

$client->userProfiles->list(?list<UserProfileEnforcementStatus> enforcementStatus, ?int limit, ?UserProfileListOrder order, ?UserProfileListOrderBy orderBy, ?string page, ?string workspaceID): PageCursor<UserProfile>

GET/v1/user_profiles

ユーザープロファイルを取得

$client->userProfiles->retrieve(string userProfileID, ?string workspaceID): UserProfile

GET/v1/user_profiles/{user_profile_id}

ユーザープロファイルを更新

$client->userProfiles->update(string userProfileID, ?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array<string,string> metadata, ?string name, ?string workspaceID): UserProfile

POST/v1/user_profiles/{user_profile_id}

ユーザープロファイルを削除

$client->userProfiles->delete(string userProfileID, ?string workspaceID): DeletedUserProfile

DELETE/v1/user_profiles/{user_profile_id}

組織

現在の組織を取得

$client->organization->retrieve(): OrganizationInfo

GET/v1/organizations/me

認証されたAPIキーに関連付けられた組織に関する情報を取得します。