Class Threads

messages

runs

create

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

• Create a thread.

  Parameters

  • Optional body: ThreadCreateParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<openai.OpenAI.Beta.Threads.Thread>
• create(options?): APIPromise<openai.OpenAI.Beta.Threads.Thread>

• Parameters

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<openai.OpenAI.Beta.Threads.Thread>

createAndRun

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

• Create a thread and run it in one request.

  Parameters

  • body: ThreadCreateAndRunParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<Run>

del

• del(threadId, options?): APIPromise<ThreadDeleted>

• Delete a thread.

  Parameters

  • threadId: string

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<ThreadDeleted>

retrieve

• retrieve(threadId, options?): APIPromise<openai.OpenAI.Beta.Threads.Thread>

• Retrieves a thread.

  Parameters

  • threadId: string

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<openai.OpenAI.Beta.Threads.Thread>

update

• update(threadId, body, options?): APIPromise<openai.OpenAI.Beta.Threads.Thread>

• Modifies a thread.

  Parameters

  • threadId: string

  • body: ThreadUpdateParams

  • Optional options: RequestOptions<unknown>

  Returns APIPromise<openai.OpenAI.Beta.Threads.Thread>