Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude

Create Job Definition Api V1 Workstreams Jobs Post

post/api/v1/workstreams/jobs

Create job definition

Create a new agentic job definition.

Request bodyapplication/json

FieldTypeDescription
namerequiredstringβ€”
descriptionstring | nullβ€”
domainrequiredstringDomain knowledge key (e.g. 'ita_2007_eis')
goal_templatestring | nullGoal template with {{variable}} placeholders. OPTIONAL: when omitted (or null), it is defaulted server-side from the domain's DomainAgent persona goal_template (PERSONA_REGISTRY.for_workstream(domain)). A domain with no registered persona falls back to the DEFAULT persona's '{{ goal }}'. An explicit value is stored verbatim (back-compat).
toolsstring[]β€”
deliverablesobject[]β€”
item shape
Empty object.
max_turnsintegerβ€”
max_cost_usdnumberβ€”
max_duration_minutesintegerβ€”
target_selectorTargetSelectorWho to run the job for.
show nested
per_client_overridesobjectβ€”
show nested
Empty object.
default_contextobjectβ€”
show nested
Empty object.
source_tracingbooleanβ€”
human_checkpointsstring[]β€”
schedulestring | nullCron expression
schedule_timezonestringβ€”

Responses

201Successful Response
FieldTypeDescription
idrequiredstring (uuid)β€”
permakeystring | nullStable human-readable key for the batch/fan-out deep-link URL /workstreams/{ws}/cycles/{permakey}/… (#173). Null on legacy rows.
namerequiredstringβ€”
descriptionstring | nullβ€”
domainrequiredstringβ€”
goal_templaterequiredstringβ€”
toolsrequiredstring[]β€”
deliverablesrequiredobject[]β€”
item shape
Empty object.
max_turnsrequiredintegerβ€”
max_cost_usdrequirednumberβ€”
max_duration_minutesrequiredintegerβ€”
target_selectorrequiredobjectβ€”
show nested
Empty object.
per_client_overridesrequiredobjectβ€”
show nested
Empty object.
default_contextrequiredobjectβ€”
show nested
Empty object.
source_tracingrequiredbooleanβ€”
human_checkpointsrequiredstring[]β€”
schedulestring | nullβ€”
schedule_timezonerequiredstringβ€”
is_enabledrequiredbooleanβ€”
next_run_atany | nullβ€”
last_run_atany | nullβ€”
statusrequiredstringβ€”
created_byrequiredstringβ€”
created_atrequiredanyβ€”
updated_atrequiredanyβ€”
current_versioninteger | nullLatest version number in job_definition_version; null if no history yet.
422Validation Error
FieldTypeDescription
detailValidationError[]β€”
item shape
curl https://api.dev.arch.ie/api/v1/workstreams/jobs \
  -X POST \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{
       "name": "string",
       "description": null,
       "domain": "string",
       "goal_template": null,
       "tools": [
         "string"
       ],
       "deliverables": [
         {}
       ],
       "max_turns": 0,
       "max_cost_usd": 0,
       "max_duration_minutes": 0,
       "target_selector": {
         "type": "string",
         "client_ids": null,
         "client_id": null,
         "tag": null
       },
       "per_client_overrides": {},
       "default_context": {},
       "source_tracing": false,
       "human_checkpoints": [
         "string"
       ],
       "schedule": null,
       "schedule_timezone": "string"
     }'
API Reference Β· Archie for developers