stable · api · 0.1.0

Schedule a registered operation

POST /api/v1/invocation-schedules

Capability Domain: Jobs Scheduling

Authentication

projectCredential (schedules:write)

Scope: schedules:write

Parameters and request body

Idempotency-Key — header, required
Idempotency-Key schema
```
{
    "type": "string",
    "maxLength": 120
}
```
X-Correlation-ID — header, optional
X-Correlation-ID schema
```
{
    "type": "string",
    "format": "uuid"
}
```

Request schema

application/json

application/json request schema

{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "registered_operation_id",
        "arguments",
        "run_at"
    ],
    "properties": {
        "registered_operation_id": {
            "type": "string",
            "format": "uuid"
        },
        "arguments": {
            "type": "object",
            "maxProperties": 50
        },
        "run_at": {
            "type": "string",
            "format": "date-time"
        },
        "interval_seconds": {
            "type": [
                "integer",
                "null"
            ],
            "minimum": 60,
            "maximum": 2678400
        }
    }
}

application/json request example

{
    "registered_operation_id": "86000000-0000-4000-8000-000000000001",
    "arguments": {
        "report_id": "weekly-sales"
    },
    "run_at": "2026-08-01T01:00:00Z",
    "interval_seconds": 86400
}

Responses and errors

Status	Description
`200`	Created schedule and first invocation
`401`	Invalid or revoked Project Credential
`403`	Project Credential lacks the required scope
`422`	Request violates the public contract

200 schema

200 response schema

{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "required": [
                "schedule_id",
                "invocation_id"
            ],
            "properties": {
                "schedule_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "invocation_id": {
                    "type": "string",
                    "format": "uuid"
                }
            }
        }
    }
}

401 schema

401 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

403 schema

403 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

422 schema

422 response schema

{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

200 example

200 response example

{
    "data": {
        "schedule_id": "87000000-0000-4000-8000-000000000001",
        "invocation_id": "88000000-0000-4000-8000-000000000001"
    }
}

Idempotency

Requires Idempotency-Key. Reuse the key only with the same operation, arguments, run time, and interval.