api.md

Shared

Types:

• APIPublicSearchResult
• BrowserSessionResponse
• ChatMessageInput
• ChatMessageOutput
• Choice
• ContextualizedEmbeddingObject
• EmbeddingObject
• EmbeddingsUsage
• JsonSchemaFormat
• ResponseFormat
• SearchResult
• UsageInfo
• UserLocation
• WebSearchOptions

Chat

Types:

• StreamChunk

Completions

Methods:

• client.chat.completions.create({ ...params }) -> StreamChunk

Search

Types:

• SearchCreateResponse

Methods:

• client.search.create({ ...params }) -> SearchCreateResponse

Responses

Types:

• Annotation
• ContentPart
• ErrorInfo
• FunctionCallOutputItem
• FunctionTool
• InputItem
• OutputItem
• ResponseFile
• ResponseFileList
• ResponseStreamChunk
• ResponsesCreateParams
• ResponsesUsage
• ResponseCreateResponse
• ResponseRetrieveResponse
• ResponseCancelResponse

Methods:

• client.responses.create({ ...params }) -> ResponseCreateResponse
• client.responses.retrieve(responseID) -> ResponseRetrieveResponse
• client.responses.cancel(responseID) -> ResponseCancelResponse

Files

Methods:

• client.responses.files.list(responseID) -> ResponseFileList
• client.responses.files.content(fileID, { ...params }) -> Response

Embeddings

Types:

• EmbeddingCreateResponse

Methods:

• client.embeddings.create({ ...params }) -> EmbeddingCreateResponse

ContextualizedEmbeddings

Types:

• ContextualizedEmbeddingCreateResponse

Methods:

• client.contextualizedEmbeddings.create({ ...params }) -> ContextualizedEmbeddingCreateResponse

Browser

Sessions

Methods:

• client.browser.sessions.create() -> BrowserSessionResponse
• client.browser.sessions.delete(sessionID) -> void

Async

Chat

Completions

Types:

• CompletionCreateResponse
• CompletionListResponse
• CompletionGetResponse

Methods:

• client.async.chat.completions.create({ ...params }) -> CompletionCreateResponse
• client.async.chat.completions.list() -> CompletionListResponse
• client.async.chat.completions.get(apiRequest, { ...params }) -> CompletionGetResponse