Skip to main content
POST
/
v3
/
agents
/
{agent_key}
/
schedules
/
{schedule_id}
/
execution
Trigger schedule execution
curl --request POST \
  --url https://api.orq.ai/v3/agents/{agent_key}/schedules/{schedule_id}/execution \
  --header 'Authorization: Bearer <token>'
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.orq.ai/v3/agents/{agent_key}/schedules/{schedule_id}/execution', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://api.orq.ai/v3/agents/{agent_key}/schedules/{schedule_id}/execution"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
{
  "schedule_id": "<string>",
  "status": "<string>"
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_key
string
required

The unique routing key of the agent the schedule belongs to.

​
schedule_id
string
required

The schedule's ULID, as returned from create.

Response

Execution scheduled for immediate delivery.

​
schedule_id
string
required
​
status
string
required

Always "triggered" on success.