Sign in
agentSchedules

Runs an agent schedule.

Immediately starts a new agent session for the selected schedule.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

post/agents/{agentId}/schedules/{scheduleId}/run

Path parameters

agentIdstring uuid required

The agent id.

scheduleIdstring uuid required

The schedule id.

Response

OK

idstring uuid

The thread id.

threadRunIdstring uuid nullable

The current run id.

acceptedMessageIdstring uuid nullable

The accepted first-message id, or null when the thread was created without a message.

typestring nullable

The thread type.

titlestring nullable

The thread title.

status'ready' | 'accepted' | 'queued' | 'failed'

The creation result: ready without a first message, accepted with a first message, queued when the first message waits for a run, or failed to start.

createdOnstring date-time nullable

The creation timestamp.

createdBystring uuid

The id of the user who created the thread.

updatedOnstring date-time nullable

The last update timestamp.

updatedBystring uuid

The id of the user who last updated the thread.

agentIdstring uuid nullable

The custom agent assigned to the thread.

projectIdstring uuid nullable

The associated project id.

taskIdstring uuid nullable

The associated task id.

clientIdstring uuid nullable

The associated client id.

documentIdstring uuid nullable

The associated document id.

Changes

Changed in 1 of the 11 revisions of this API.1