Class CronsClient

Hierarchy

BaseClient
- CronsClient

Index

Constructors

constructor

new CronsClient(config?: ClientConfig): CronsClient
Parameters
- Optionalconfig: ClientConfig
Returns CronsClient
Inherited from BaseClient.constructor
- Defined in client.ts:193

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?: { assistantId?: string; threadId?: string }): Promise<number>
Count cron jobs matching filters.
Parameters
- Optionalquery: { assistantId?: string; threadId?: string }
  - OptionalassistantId?: string
    Assistant ID to filter by.
  - OptionalthreadId?: string
    Thread ID to filter by.
Returns Promise<number>
Number of cron jobs matching the criteria.
- Defined in client.ts:457

create

create(
assistantId: string,
payload?: CronsCreatePayload,
): Promise<CronCreateResponse>
Parameters
- assistantId: string
  Assistant ID to use for this cron job.
- Optionalpayload: CronsCreatePayload
  Payload for creating a cron job.
Returns Promise<CronCreateResponse>
- Defined in client.ts:387

createForThread

createForThread(
    threadId: string,
    assistantId: string,
    payload?: CronsCreatePayload,
): Promise<CronCreateForThreadResponse>
Parameters
- threadId: string
  The ID of the thread.
- assistantId: string
  Assistant ID to use for this cron job.
- Optionalpayload: CronsCreatePayload
  Payload for creating a cron job.
Returns Promise<CronCreateForThreadResponse>
The created background run.
- Defined in client.ts:352

delete

delete(cronId: string): Promise<void>
Parameters
- cronId: string
  Cron ID of Cron job to delete.
Returns Promise<void>
- Defined in client.ts:416

`Protected`fetch

fetch<T>(
    path: string,
    options: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse: true;
    },
): 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]>
Inherited from BaseClient.fetch
- Defined in client.ts:288
fetch<T>(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse?: false;
    },
): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      signal?: AbortSignal;
      timeoutMs?: null | number;
      withResponse?: false;
  }
Returns Promise<T>
Inherited from BaseClient.fetch
- Defined in client.ts:299

`Protected`prepareFetchOptions

prepareFetchOptions(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        timeoutMs?: null | number;
        withResponse?: boolean;
    },
): [url: URL, init: RequestInit]
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      timeoutMs?: null | number;
      withResponse?: boolean;
  }
Returns [url: URL, init: RequestInit]
Inherited from BaseClient.prepareFetchOptions
- Defined in client.ts:233

search

search(
    query?: {
        assistantId?: string;
        limit?: number;
        offset?: number;
        select?: CronSelectField[];
        sortBy?: CronSortBy;
        sortOrder?: SortOrder;
        threadId?: string;
    },
): Promise<Cron[]>
Parameters
- Optionalquery: {
      assistantId?: string;
      limit?: number;
      offset?: number;
      select?: CronSelectField[];
      sortBy?: CronSortBy;
      sortOrder?: SortOrder;
      threadId?: string;
  }
  Query options.
Returns Promise<Cron[]>
List of crons.
- Defined in client.ts:427

Class CronsClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CronsClient

Properties

ProtectedapiUrl

ProtectedasyncCaller

ProtecteddefaultHeaders

Protected OptionalonRequest

ProtectedtimeoutMs

Methods

count

Parameters

OptionalassistantId?: string

OptionalthreadId?: string

Returns Promise<number>

create

Parameters

Returns Promise<CronCreateResponse>

createForThread

Parameters

Returns Promise<CronCreateForThreadResponse>

delete

Parameters

Returns Promise<void>

Protectedfetch

Type Parameters

Parameters

Returns Promise<[T, Response]>

Type Parameters

Parameters

Returns Promise<T>

ProtectedprepareFetchOptions

Parameters

Returns [url: URL, init: RequestInit]

search

Parameters

Returns Promise<Cron[]>

Settings

On This Page

`Protected`apiUrl

`Protected`asyncCaller

`Protected`defaultHeaders

`Protected` `Optional`onRequest

`Protected`timeoutMs

`Optional`assistantId?: string

`Optional`threadId?: string

`Protected`fetch

`Protected`prepareFetchOptions