Hierarchy

  • APIResource
    • Assistants

Constructors

  • Parameters

    Returns Assistants

Methods

  • Create an assistant with a model and instructions.

    Parameters

    Returns APIPromise<Assistant>

    const assistant = await client.beta.assistants.create({
    model: 'gpt-4o',
    });
  • Delete an assistant.

    Parameters

    • assistantID: string
    • Optionaloptions: RequestOptions

    Returns APIPromise<AssistantDeleted>

    const assistantDeleted =
    await client.beta.assistants.delete('assistant_id');
  • Returns a list of assistants.

    Parameters

    Returns PagePromise<AssistantsPage, Assistant>

    // Automatically fetches more pages as needed.
    for await (const assistant of client.beta.assistants.list()) {
    // ...
    }
  • Retrieves an assistant.

    Parameters

    • assistantID: string
    • Optionaloptions: RequestOptions

    Returns APIPromise<Assistant>

    const assistant = await client.beta.assistants.retrieve(
    'assistant_id',
    );
  • Modifies an assistant.

    Parameters

    Returns APIPromise<Assistant>

    const assistant = await client.beta.assistants.update(
    'assistant_id',
    );