2.5 KiB
@langchain/langgraph-sdk / CronsClient
Class: CronsClient
Defined in: client.ts:334
Extends
BaseClient
Constructors
new CronsClient()
new CronsClient(
config?):CronsClient
Defined in: client.ts:183
Parameters
config?
Returns
Inherited from
BaseClient.constructor
Methods
create()
create(
assistantId,payload?):Promise<CronCreateResponse>
Defined in: client.ts:375
Parameters
assistantId
string
Assistant ID to use for this cron job.
payload?
CronsCreatePayload
Payload for creating a cron job.
Returns
Promise<CronCreateResponse>
createForThread()
createForThread(
threadId,assistantId,payload?):Promise<CronCreateForThreadResponse>
Defined in: client.ts:342
Parameters
threadId
string
The ID of the thread.
assistantId
string
Assistant ID to use for this cron job.
payload?
CronsCreatePayload
Payload for creating a cron job.
Returns
Promise<CronCreateForThreadResponse>
The created background run.
delete()
delete(
cronId):Promise<void>
Defined in: client.ts:402
Parameters
cronId
string
Cron ID of Cron job to delete.
Returns
Promise<void>
search()
search(
query?):Promise<Cron[]>
Defined in: client.ts:413
Parameters
query?
Query options.
assistantId?
string
limit?
number
offset?
number
threadId?
string
Returns
Promise<Cron[]>
List of crons.