Skip to main content
POST
Create template

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request model for creating or updating a crew template.

name
string
required

Human-readable template name.

crew_config
CrewConfig · object
required

The full crew configuration to save.

description
string
default:""

Optional description.

tags
string[]

Tags for categorization.

variables
TemplateVariable · object[]

Declared inputs the template's tasks expect. Empty list preserves the legacy free-form task_input behavior.

is_shared
boolean
default:false

Whether this template is visible to all users.

Response

Successful Response

Response model for a crew template returned from the API.

id
string
required

Unique ID for the template.

name
string
required

Human-readable name for the template.

description
string
required

What the template does.

crew_config
CrewConfig · object
required

The crew configuration saved in this template.

tags
string[]
required

Tags for categorizing the template.

is_shared
boolean
required

True if every user can see this template, false if only its creator can.

created_by
string
required

Keycloak username of whoever created the template.

updated_by
string
required

Keycloak username of whoever last updated the template.

created_at
string
required

Creation time of the template. Represented as an ISO 8601 timestamp.

updated_at
string
required

Last update time of the template. Represented as an ISO 8601 timestamp.

variables
TemplateVariable · object[]

Declared inputs the template's tasks reference as {placeholders}. Empty for a free-form template.

pins
TemplatePin · object[]

The registry versions this template pins, with whether a newer approved version is available and anything that stops it running.

lint_warnings
string[]

Authoring-time warnings about drift between the declared variables and the {placeholders} referenced by tasks. Surfaced on create or update. Usually empty on read.