AI Workforce OneHQDocs

Templates

The AI team templates your organization owns.

List templates

GET/v1/templates
Permission templates:read
Query parameters
limitinteger

How many objects to return, 1 to 100. Default 20.

starting_afterstring

Return objects older than this id (the next page).

ending_beforestring

Return objects newer than this id (the previous page).

Headers
HQ-Versionstring (date)

A dated API version. Defaults to the version the key was created with.

HQ-Accountstring

Agency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with 400 invalid_request on any other credential. A slug that is not one of your agency's current clients is 404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.

Returns a list of Template objects.

Responses
200

A page of templates.

Other

An RFC 9457 problem.

Get a template

GET/v1/templates/{template_id}
Permission templates:read
Path parameters
template_idstringrequired

A template id.

Headers
HQ-Versionstring (date)

A dated API version. Defaults to the version the key was created with.

HQ-Accountstring

Agency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with 400 invalid_request on any other credential. A slug that is not one of your agency's current clients is 404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.

Returns a Template object.

Responses
200

The template.

Other

An RFC 9457 problem.

Objects

Template

Attributes
objectstring
idstring
namestring
descriptionstring
versionstring
enginestring
originstring
revisioninteger
created_atstring (date-time)