Class CronsClient

Hierarchy

  • BaseClient
    • CronsClient

Constructors

constructor

Properties

apiUrl asyncCaller defaultHeaders onRequest? timeoutMs

Methods

count create createForThread delete fetch prepareFetchOptions search

Constructors

constructor

  • new CronsClient(config?): CronsClient

  • Parameters

    Returns CronsClient

Properties

Protected apiUrl

apiUrl: string

Protected asyncCaller

asyncCaller: AsyncCaller

Protected defaultHeaders

defaultHeaders: Record<string, HeaderValue>

Protected Optional onRequest

onRequest?: RequestHook

Protected timeoutMs

timeoutMs: undefined | number

Methods

count

  • count(query?): Promise<number>

  • Count cron jobs matching filters.

    Parameters

    • Optional query: {
          assistantId?: string;
          threadId?: string;
      }
      • Optional assistantId?: string

        Assistant ID to filter by.

      • Optional threadId?: string

        Thread ID to filter by.

    Returns Promise<number>

    Number of cron jobs matching the criteria.

create

  • create(assistantId, payload?): Promise<CronCreateResponse>

  • Parameters

    • assistantId: string

      Assistant ID to use for this cron job.

    • Optional payload: CronsCreatePayload

      Payload for creating a cron job.

    Returns Promise<CronCreateResponse>

createForThread

  • createForThread(threadId, assistantId, payload?): Promise<CronCreateForThreadResponse>

  • Parameters

    • threadId: string

      The ID of the thread.

    • assistantId: string

      Assistant ID to use for this cron job.

    • Optional payload: CronsCreatePayload

      Payload for creating a cron job.

    Returns Promise<CronCreateForThreadResponse>

    The created background run.

delete

  • delete(cronId): Promise<void>

  • Parameters

    • cronId: string

      Cron ID of Cron job to delete.

    Returns Promise<void>

Protected fetch

  • fetch<T>(path, options): Promise<[T, Response]>

  • Type Parameters

    • T

    Parameters

    • path: string
    • options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          signal?: AbortSignal;
          timeoutMs?: null | number;
          withResponse: true;
      }

    Returns Promise<[T, Response]>

  • fetch<T>(path, options?): Promise<T>

  • Type Parameters

    • T

    Parameters

    • path: string
    • Optional options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          signal?: AbortSignal;
          timeoutMs?: null | number;
          withResponse?: false;
      }

    Returns Promise<T>

Protected prepareFetchOptions

  • prepareFetchOptions(path, options?): [url: URL, init: RequestInit]

  • Parameters

    • path: string
    • Optional options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          timeoutMs?: null | number;
          withResponse?: boolean;
      }

    Returns [url: URL, init: RequestInit]

search

  • search(query?): Promise<Cron[]>

  • Parameters

    • Optional query: {
          assistantId?: string;
          limit?: number;
          offset?: number;
          select?: CronSelectField[];
          sortBy?: CronSortBy;
          sortOrder?: SortOrder;
          threadId?: string;
      }

      Query options.

      • Optional assistantId?: string
      • Optional limit?: number
      • Optional offset?: number
      • Optional select?: CronSelectField[]
      • Optional sortBy?: CronSortBy
      • Optional sortOrder?: SortOrder
      • Optional threadId?: string

    Returns Promise<Cron[]>

    List of crons.

Settings

Member Visibility

Theme

On This Page

constructorapiUrlasyncCallerdefaultHeadersonRequesttimeoutMscountcreatecreateForThreaddeletefetchprepareFetchOptionssearch