API ReferenceApi claw

Create API Agent scheduled task

API documentation for Create API Agent scheduled task

POST
/api/v1/api-agents/{agentId}/scheduled-tasks

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication.

In: header

Path Parameters

agentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/v1/api/v1/api-agents/string/scheduled-tasks" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "scheduleType": "cron"  }'
{
  "id": "string",
  "name": "string",
  "agentId": "string",
  "taskTemplate": {
    "property1": null,
    "property2": null
  },
  "scheduleType": "string",
  "cronExpression": "string",
  "intervalMinutes": 0,
  "scheduledAt": "string",
  "maxRuns": 0,
  "timezone": "string",
  "isEnabled": true,
  "nextRunAt": "string",
  "totalRuns": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "scheduleDescription": "string",
  "agent": {
    "name": "string",
    "emoji": "string"
  },
  "runs": [
    {
      "id": "string",
      "scheduledTaskId": "string",
      "status": "string",
      "startedAt": "string",
      "completedAt": "string",
      "error": "string",
      "sessionId": "string",
      "createdAt": "string"
    }
  ]
}
{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": {
    "error": "string"
  }
}
{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": {
    "error": "string"
  }
}
{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": {
    "error": "string"
  }
}
{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": {
    "error": "string"
  }
}