Class Threads

constructor

• new Threads(client): Threads

• Parameters

  • client: OpenAIClient

  Returns Threads

messages

runs

create

• create(body?, options?): APIPromise<OpenAIClient.Beta.Threads.Thread>

• Create a thread.

  Parameters

  • Optionalbody: null | ThreadCreateParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Beta.Threads.Thread>

  Deprecated

  The Assistants API is deprecated in favor of the Responses API

createAndRun

• createAndRun(body, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

• Create a thread and run it in one request.

  Parameters

  • body: OpenAIClient.Beta.Threads.ThreadCreateAndRunParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

  Deprecated

  The Assistants API is deprecated in favor of the Responses API

• createAndRun(body, options?): APIPromise<Stream<AssistantStreamEvent>>

• Parameters

  • body: OpenAIClient.Beta.Threads.ThreadCreateAndRunParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<AssistantStreamEvent>>

• createAndRun(body, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

• Parameters

  • body: ThreadCreateAndRunParamsBase
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

createAndRunPoll

• createAndRunPoll(body, options?): Promise<OpenAIClient.Beta.Threads.Runs.Run>

• A helper to create a thread, start a run and then poll for a terminal state. More information on Run lifecycles can be found here: https://platform.openai.com/docs/assistants/how-it-works/runs-and-run-steps

  Parameters

  • body: OpenAIClient.Beta.Threads.ThreadCreateAndRunParamsNonStreaming
  • Optionaloptions: RequestOptions & {
        pollIntervalMs?: number;
    }

  Returns Promise<OpenAIClient.Beta.Threads.Runs.Run>

createAndRunStream

• createAndRunStream(body, options?): AssistantStream

• Create a thread and stream the run back

  Parameters

  • body: ThreadCreateAndRunParamsBaseStream
  • Optionaloptions: RequestOptions

  Returns AssistantStream

delete

• delete(threadID, options?): APIPromise<ThreadDeleted>

• Delete a thread.

  Parameters

  • threadID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<ThreadDeleted>

  Deprecated

  The Assistants API is deprecated in favor of the Responses API

retrieve

• retrieve(threadID, options?): APIPromise<OpenAIClient.Beta.Threads.Thread>

• Retrieves a thread.

  Parameters

  • threadID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Beta.Threads.Thread>

  Deprecated

  The Assistants API is deprecated in favor of the Responses API

update

• update(threadID, body, options?): APIPromise<OpenAIClient.Beta.Threads.Thread>

• Modifies a thread.

  Parameters

  • threadID: string
  • body: ThreadUpdateParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Beta.Threads.Thread>

  Deprecated

  The Assistants API is deprecated in favor of the Responses API