API referenceSchedules
Dispatch Schedule
POST
/api/v1/schedules/{schedule_id}/dispatchAuthorizationBearer <token>
A workspace API key (a13n_...)
In: header
Path Parameters
schedule_id*Schedule Id
Header Parameters
Idempotency-Key*Idempotency-Key
Match
^[!-~]+$Length
1 <= length <= 512If-Match?|
The resource's ETag: "{id}:{version}" of its current view, "{key}:{version}" for a model
X-Workspace-ID?|
The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Commands accept no configuration or authority overrides.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/schedules/string/dispatch" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{ "completed_at": "2019-08-24T14:15:22Z", "completion_run_id": "string", "covered_from_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "deadline_at": "2019-08-24T14:15:22Z", "dispatch_attempts": 0, "entry_id": "string", "execution": { "has_unfinished_work": true, "initial_entry_status": "pending", "initial_run": { "id": "string", "status": "accepted" }, "observed_at": "2019-08-24T14:15:22Z" }, "execution_outcome": "succeeded", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "last_error": "string", "next_attempt_at": "2019-08-24T14:15:22Z", "principal_id": "string", "reason": "string", "requested_by_id": "string", "schedule_id": "string", "schedule_version": 0, "scheduled_at": "2019-08-24T14:15:22Z", "session_id": "string", "snapshot": { "invocation": { "agent_id": "string", "agent_revision_id": "string", "memories": [], "options": { "configuration": { "allowed_hosts": [ "string" ], "extensions": { "property1": null, "property2": null } }, "context": { "headers": { "property1": "string", "property2": "string" } }, "execution": { "environment": { "property1": "string", "property2": "string" }, "steering": "boundary", "tools": { "foreground_wait_seconds": 0, "mode": "inline" } }, "labels": { "property1": "string", "property2": "string" }, "max_usage": { "requests": 1 }, "overrides": { "builtin_skills": [ "platform-operations" ], "client_tools": [ { "description": "string", "instruction": "string", "metadata": { "property1": null, "property2": null }, "name": "string", "parameters_json_schema": { "property1": null, "property2": null }, "permission": "inherit" } ], "connection_tools": [ { "connection_id": "string", "permission": "inherit", "permissions": { "property1": "allow", "property2": "allow" }, "tools": [ "string" ] } ], "instructions": "string", "lazy_environment": true, "media_understanding": { "audio": "string", "image": "string", "video": "string" }, "model": "string", "model_characteristics": { "compact_threshold": 0.9, "context_window_tokens": 1, "proactive_context_management_threshold": 0.65 }, "model_settings": { "property1": null, "property2": null }, "output_spec": { "description": "string", "name": "string", "resources": {}, "schema": { "property1": null, "property2": null }, "variants": [ { "description": "string", "name": "string", "resources": {}, "schema": { "property1": null, "property2": null } }, { "description": "string", "name": "string", "resources": {}, "schema": { "property1": null, "property2": null } } ] }, "plugins": [ { "config": { "property1": null, "property2": null }, "instance_name": "string", "plugin_key": "string" } ], "retries": { "output": 0, "tools": 0 }, "reviewer": { "instruction": "string", "model": "string", "model_settings": { "property1": null, "property2": null }, "on_error": "deny", "on_flagged": "deny", "risk_threshold": "low", "rules": { "property1": { "on_flagged": "deny", "risk_threshold": "low" }, "property2": { "on_flagged": "deny", "risk_threshold": "low" } }, "shell_instruction": "string", "timeout_seconds": 120 }, "skill_sync": { "cleanup": false, "mode": "shared", "overwrite": true }, "skills": [ { "revision_id": "string", "skill_id": "string" } ], "subagents": {}, "tool_search": { "config": { "call_name": "call_tool", "describe_name": "describe_tool", "groups_name": "list_tool_groups", "list_name": "list_tools", "max_results": 10, "max_search_bytes": 32768, "mode": "proxy", "search_name": "discover_tools" }, "groups": { "property1": { "capabilities": [], "connections": [], "description": "string", "platform": false, "plugins": [] }, "property2": { "capabilities": [], "connections": [], "description": "string", "platform": false, "plugins": [] } } }, "toolsets": { "property1": { "config": { "property1": null, "property2": null }, "enabled": true, "tools": {} }, "property2": { "config": { "property1": null, "property2": null }, "enabled": true, "tools": {} } } } }, "payload": { "content": [ { "text": "string", "type": "text" } ] } }, "max_lateness_seconds": 0, "name": "string", "schedule": { "expression": "string", "timezone": "string", "type": "cron" }, "timezone_data_version": "string", "utc_offset_seconds": 0 }, "status": "pending", "thread_id": "string", "trigger": "scheduled", "updated_at": "2019-08-24T14:15:22Z", "version": 0}