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

傳送包含文字和／或圖片內容的結構化輸入訊息清單，模型將產生對話中的下一則訊息。

計算訊息中的 Token 數

$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

計算訊息中的 Token 數量。

模型

列出模型

$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 金鑰相關聯之組織的資訊。