Responses

interface Responses

Create and manage model responses.

Inheritors

Functions

Link copied to clipboard
abstract suspend fun cancel(id: ResponseId, requestOptions: RequestOptions? = null): Response?

Cancels an in-progress response.

Link copied to clipboard
open suspend fun cancelResponse(id: ResponseId, requestOptions: RequestOptions? = null): ResponseResult?

Cancels a background response and returns its current result metadata.

Link copied to clipboard
open suspend fun compactResponse(request: ResponseCompactRequest, requestOptions: RequestOptions? = null): ResponseCompaction

Compacts context into items suitable for a later response.

Link copied to clipboard
open suspend fun createResponse(request: ResponseCreateRequest, requestOptions: RequestOptions? = null): ResponseResult

Creates a response with current request controls and complete result metadata.

Link copied to clipboard
abstract suspend fun delete(id: ResponseId, requestOptions: RequestOptions? = null): Boolean

Deletes a stored response.

Link copied to clipboard
abstract suspend fun response(id: ResponseId, requestOptions: RequestOptions? = null): Response?

Retrieves a response by its identifier.

abstract suspend fun response(request: ResponseRequest, requestOptions: RequestOptions? = null): Response

Creates a model response.

Link copied to clipboard
abstract suspend fun responseInputItems(id: ResponseId, limit: Int? = null, order: SortOrder? = null, after: String? = null, before: String? = null, requestOptions: RequestOptions? = null): PaginatedList<ResponseInputItem>

Lists input items for a response.

Link copied to clipboard
open suspend fun responseInputItemsPage(id: ResponseId, include: List<String> = emptyList(), limit: Int? = null, order: SortOrder? = null, after: String? = null, before: String? = null, requestOptions: RequestOptions? = null): PaginatedList<ResponseInputEntry>

Lists current input items, optionally including tool or reasoning fields.

Link copied to clipboard
open suspend fun responseInputTokens(request: ResponseTokenCountRequest, requestOptions: RequestOptions? = null): ResponseTokenCount

Counts input tokens without generating output.

Link copied to clipboard
open suspend fun <T> responseSession(secure: Boolean = true, requestOptions: RequestOptions? = null, block: suspend ResponseConnection.() -> T): T

Opens a scoped Responses WebSocket. The block owns the connection lifetime. Requires a WebSocket-capable engine. secure=false is intended only for trusted local servers.

Link copied to clipboard
open fun resumeResponse(id: ResponseId, startingAfter: Int? = null, include: List<String>? = null, includeObfuscation: Boolean? = null, requestOptions: RequestOptions? = null): Flow<ResponseStreamEvent>

Resumes events from a stored background response after a sequence number.

Link copied to clipboard
open suspend fun retrieveResponse(id: ResponseId, include: List<String> = emptyList(), requestOptions: RequestOptions? = null): ResponseResult?

Retrieves a current response, optionally including additional tool or reasoning fields.

Link copied to clipboard
open fun streamResponses(request: ResponseCreateRequest, requestOptions: RequestOptions? = null): Flow<ResponseStreamEvent>

Streams a current response. Cancelling collection closes the HTTP connection.