Overview
Endpoints
- GETList jobs
- POSTCreate a job
- POSTBatch create jobs
- POSTBatch disable jobs
- POSTBatch enable jobs
- GETGet a job
- DELDelete a job
- PATCHUpdate a job
- POSTClone a job
- GETList job dependencies
- POSTCreate a job dependency
- DELDelete a job dependency
- GETGet job health
- POSTPause a job
- POSTResume a job
- POSTTrigger a job
- POSTBulk trigger a job
- GETList job versions
- GETGet a job version
Jobs
Update a job
Updates an existing job’s configuration.
PATCH
/
v1
/
jobs
/
{jobID}
Update a job
curl --request PATCH \
--url https://api.strait.dev/v1/jobs/{jobID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"backwards_compatible": true,
"batch_max_size": 123,
"batch_window_secs": 123,
"cron": "<string>",
"cron_overlap_policy": "<string>",
"debounce_window_secs": 123,
"dedup_window_secs": 123,
"default_run_metadata": {},
"description": "<string>",
"enabled": true,
"endpoint_url": "<string>",
"environment_id": "<string>",
"execution_mode": "<string>",
"execution_window_cron": "<string>",
"fallback_endpoint_url": "<string>",
"group_id": "<string>",
"image_uri": "<string>",
"machine_preset": "<string>",
"max_attempts": 123,
"max_concurrency": 123,
"max_concurrency_per_key": 123,
"name": "<string>",
"on_complete_payload_mapping": "<unknown>",
"on_complete_trigger_job": "<string>",
"on_complete_trigger_workflow": "<string>",
"on_failure_payload_mapping": "<unknown>",
"on_failure_trigger_job": "<string>",
"on_failure_trigger_workflow": "<string>",
"payload_schema": "<unknown>",
"poison_pill_threshold": 123,
"preferred_regions": [
"<string>"
],
"rate_limit_max": 123,
"rate_limit_window_secs": 123,
"region": "<string>",
"result_schema": "<unknown>",
"retry_delays_secs": [
123
],
"retry_priority_boost": 123,
"retry_strategy": "<string>",
"run_ttl_secs": 123,
"slug": "<string>",
"tags": {},
"timeout_secs": 123,
"timezone": "<string>",
"version_policy": "<string>"
}
'{
"created_at": "2023-11-07T05:31:56Z",
"enabled": true,
"endpoint_url": "<string>",
"id": "<string>",
"max_attempts": 123,
"name": "<string>",
"paused": true,
"project_id": "<string>",
"slug": "<string>",
"timeout_secs": 123,
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"$schema": "<string>",
"allowed_tools": [
"<string>"
],
"backwards_compatible": true,
"batch_max_size": 123,
"batch_window_secs": 123,
"blocked_tools": [
"<string>"
],
"created_by": "<string>",
"cron": "<string>",
"cron_overlap_policy": "<string>",
"debounce_window_secs": 123,
"dedup_window_secs": 123,
"default_run_metadata": {},
"description": "<string>",
"dlq_alert_threshold": 123,
"environment_id": "<string>",
"execution_mode": "<string>",
"execution_window_cron": "<string>",
"fallback_endpoint_url": "<string>",
"group_id": "<string>",
"image_uri": "<string>",
"machine_preset": "<string>",
"max_concurrency": 123,
"max_concurrency_per_key": 123,
"max_iterations_per_run": 123,
"max_tokens_per_run": 123,
"max_tool_calls_per_run": 123,
"on_complete_payload_mapping": "<unknown>",
"on_complete_trigger_job": "<string>",
"on_complete_trigger_workflow": "<string>",
"on_failure_payload_mapping": "<unknown>",
"on_failure_trigger_job": "<string>",
"on_failure_trigger_workflow": "<string>",
"pause_reason": "<string>",
"paused_at": "2023-11-07T05:31:56Z",
"payload_schema": "<unknown>",
"poison_pill_threshold": 123,
"preferred_regions": [
"<string>"
],
"queue_depth_alert_threshold": 123,
"rate_limit_keys": [
{
"max": 123,
"name": "<string>",
"window_secs": 123
}
],
"rate_limit_max": 123,
"rate_limit_window_secs": 123,
"region": "<string>",
"result_schema": "<unknown>",
"retry_delays_secs": [
123
],
"retry_priority_boost": 123,
"retry_strategy": "<string>",
"run_ttl_secs": 123,
"tags": {},
"timezone": "<string>",
"updated_by": "<string>",
"version_id": "<string>",
"version_policy": "<string>",
"webhook_url": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.strait.dev/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key passed as Bearer token
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Consecutive identical errors before auto-quarantine to DLQ. NULL or 0 disables.
Show child attributes
Show child attributes
Response
OK
A URL to the JSON Schema for this object.
Example:
"https://api.strait.dev/schemas/Job.json"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Update a job
curl --request PATCH \
--url https://api.strait.dev/v1/jobs/{jobID} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"backwards_compatible": true,
"batch_max_size": 123,
"batch_window_secs": 123,
"cron": "<string>",
"cron_overlap_policy": "<string>",
"debounce_window_secs": 123,
"dedup_window_secs": 123,
"default_run_metadata": {},
"description": "<string>",
"enabled": true,
"endpoint_url": "<string>",
"environment_id": "<string>",
"execution_mode": "<string>",
"execution_window_cron": "<string>",
"fallback_endpoint_url": "<string>",
"group_id": "<string>",
"image_uri": "<string>",
"machine_preset": "<string>",
"max_attempts": 123,
"max_concurrency": 123,
"max_concurrency_per_key": 123,
"name": "<string>",
"on_complete_payload_mapping": "<unknown>",
"on_complete_trigger_job": "<string>",
"on_complete_trigger_workflow": "<string>",
"on_failure_payload_mapping": "<unknown>",
"on_failure_trigger_job": "<string>",
"on_failure_trigger_workflow": "<string>",
"payload_schema": "<unknown>",
"poison_pill_threshold": 123,
"preferred_regions": [
"<string>"
],
"rate_limit_max": 123,
"rate_limit_window_secs": 123,
"region": "<string>",
"result_schema": "<unknown>",
"retry_delays_secs": [
123
],
"retry_priority_boost": 123,
"retry_strategy": "<string>",
"run_ttl_secs": 123,
"slug": "<string>",
"tags": {},
"timeout_secs": 123,
"timezone": "<string>",
"version_policy": "<string>"
}
'{
"created_at": "2023-11-07T05:31:56Z",
"enabled": true,
"endpoint_url": "<string>",
"id": "<string>",
"max_attempts": 123,
"name": "<string>",
"paused": true,
"project_id": "<string>",
"slug": "<string>",
"timeout_secs": 123,
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"$schema": "<string>",
"allowed_tools": [
"<string>"
],
"backwards_compatible": true,
"batch_max_size": 123,
"batch_window_secs": 123,
"blocked_tools": [
"<string>"
],
"created_by": "<string>",
"cron": "<string>",
"cron_overlap_policy": "<string>",
"debounce_window_secs": 123,
"dedup_window_secs": 123,
"default_run_metadata": {},
"description": "<string>",
"dlq_alert_threshold": 123,
"environment_id": "<string>",
"execution_mode": "<string>",
"execution_window_cron": "<string>",
"fallback_endpoint_url": "<string>",
"group_id": "<string>",
"image_uri": "<string>",
"machine_preset": "<string>",
"max_concurrency": 123,
"max_concurrency_per_key": 123,
"max_iterations_per_run": 123,
"max_tokens_per_run": 123,
"max_tool_calls_per_run": 123,
"on_complete_payload_mapping": "<unknown>",
"on_complete_trigger_job": "<string>",
"on_complete_trigger_workflow": "<string>",
"on_failure_payload_mapping": "<unknown>",
"on_failure_trigger_job": "<string>",
"on_failure_trigger_workflow": "<string>",
"pause_reason": "<string>",
"paused_at": "2023-11-07T05:31:56Z",
"payload_schema": "<unknown>",
"poison_pill_threshold": 123,
"preferred_regions": [
"<string>"
],
"queue_depth_alert_threshold": 123,
"rate_limit_keys": [
{
"max": 123,
"name": "<string>",
"window_secs": 123
}
],
"rate_limit_max": 123,
"rate_limit_window_secs": 123,
"region": "<string>",
"result_schema": "<unknown>",
"retry_delays_secs": [
123
],
"retry_priority_boost": 123,
"retry_strategy": "<string>",
"run_ttl_secs": 123,
"tags": {},
"timezone": "<string>",
"updated_by": "<string>",
"version_id": "<string>",
"version_policy": "<string>",
"webhook_url": "<string>"
}