DOC-API-MODEL-schema-1lbkptb5rj#overview
ScheduleTarget
ScheduleTarget describes the HTTP endpoint that receives each job invocation.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#request-field-urlurl | string (uri) | Required in requests | Destination URL. Must be a valid absolute URI. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#request-field-methodmethod | string | Optional | HTTP method to use. Defaults to "POST". |
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#request-field-kindkind | string | Required in requests | Logical kind used for routing and observability (e.g., "notification", "llm_conversation", "metering"). Required. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#request-field-payloadpayload | Map from string to JSON value | Optional | Arbitrary JSON payload forwarded verbatim to the target. |
Request validation
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
url | Minimum length | 1 |
url | Uri | true |
kind | Minimum length | 1 |
In responses
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#field-urlSection ID: DOC-API-MODEL-schema-1lbkptb5rj#response-field-urlurl | string | Required in requests | Destination URL. Must be a valid absolute URI. |
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#field-methodSection ID: DOC-API-MODEL-schema-1lbkptb5rj#response-field-methodmethod | string | Optional | HTTP method to use. Defaults to "POST". |
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#field-kindSection ID: DOC-API-MODEL-schema-1lbkptb5rj#response-field-kindkind | string | Required in requests | Logical kind used for routing and observability (e.g., "notification", "llm_conversation", "metering"). Required. |
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#field-payloadSection ID: DOC-API-MODEL-schema-1lbkptb5rj#response-field-payloadpayload | Map from string to JSON value | Optional | Arbitrary JSON payload forwarded verbatim to the target. |
DOC-API-MODEL-schema-1lbkptb5rj#validation
Request validation
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
url | Minimum length | 1 |
url | Uri | true |
kind | Minimum length | 1 |
Where used
Section ID: DOC-API-MODEL-schema-1lbkptb5rj#where-used
| Reference | Relationship |
|---|---|
| Create a scheduled job | POST /api/v1/scheduler/create-job |
| Get a scheduled job | POST /api/v1/scheduler/get-job |
| List scheduled jobs | POST /api/v1/scheduler/list-jobs |
| Pause a scheduled job | POST /api/v1/scheduler/pause-job |
| Resume a scheduled job | POST /api/v1/scheduler/resume-job |
| Update a scheduled job | POST /api/v1/scheduler/update-job |
Models containing this value
| Model | Relationship |
|---|---|
| Schedule | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1lbkptb5rj