PHP API reference

Messages

Create a Message

$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

Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation.

Count tokens in a Message

$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

Count the number of tokens in a Message.

Models

List Models

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

GET/v1/models

List available models.

Get a Model

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

GET/v1/models/{model_id}

Get a specific model.

Files

Upload File

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

POST/v1/files

List Files

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

GET/v1/files

Download File

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

GET/v1/files/{file_id}/content

Get File Metadata

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

GET/v1/files/{file_id}

Delete File

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

DELETE/v1/files/{file_id}

Skills

Create Skill

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

POST/v1/skills

List Skills

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

GET/v1/skills

Get Skill

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

GET/v1/skills/{skill_id}

Delete Skill

$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

List User Profiles

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

GET/v1/user_profiles

Get User Profile

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

GET/v1/user_profiles/{user_profile_id}

Update User Profile

$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}

Delete User Profile

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

DELETE/v1/user_profiles/{user_profile_id}

Organization

Get Current Organization

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

GET/v1/organizations/me

Retrieve information about the organization associated with the authenticated API key.