TypeScript API reference

Completions

Create a Text Completion

Deprecated

client.completions.create(params, options?): Completion | Stream<Completion>

POST/v1/complete

[Legacy] Create a Text Completion.

Messages

Create a Message

client.messages.create(params, options?): Message | Stream<RawMessageStreamEvent>

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(params, options?): MessageTokensCount

POST/v1/messages/count_tokens

Count the number of tokens in a Message.

Models

List Models

client.models.list(params?, options?): Page<ModelInfo>

GET/v1/models

List available models.

Get a Model

client.models.retrieve(modelID, params?, options?): ModelInfo

GET/v1/models/{model_id}

Get a specific model.

Files

Upload File

client.files.upload(params, options?): FileMetadata

POST/v1/files

List Files

client.files.list(params?, options?): PageCursor<FileMetadata>

GET/v1/files

Download File

client.files.download(fileID, params?, options?): Response

GET/v1/files/{file_id}/content

Get File Metadata

client.files.retrieveMetadata(fileID, params?, options?): FileMetadata

GET/v1/files/{file_id}

Delete File

client.files.delete(fileID, params?, options?): DeletedFile

DELETE/v1/files/{file_id}

Skills

Create Skill

client.skills.create(params, options?): Skill

POST/v1/skills

List Skills

client.skills.list(params?, options?): PageCursor<Skill>

GET/v1/skills

Get Skill

client.skills.retrieve(skillID, params?, options?): Skill

GET/v1/skills/{skill_id}

Delete Skill

client.skills.delete(skillID, params?, options?): DeletedSkill

DELETE/v1/skills/{skill_id}

Organization

Get Current Organization

client.organization.retrieve(options?): OrganizationInfo

GET/v1/organizations/me

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