ai_agents_preset_templates

Creates, updates, deletes, gets or lists an ai_agents_preset_templates resource.

Overview

Name	ai_agents_preset_templates
Type	Resource
Id	ovh.public_cloud.ai_agents_preset_templates

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Identifier to pass as targetSpec.template.id when creating an agent from this preset
name	string	Human-readable name of the preset
ai_endpoints	boolean	Whether an agent created from this preset uses the OVHcloud AI Endpoints provider preset (wire: aiEndpoints)
ai_endpoints_integrated_auth	boolean	Whether the AI Endpoints credential is minted by this service rather than supplied by the caller (wire: aiEndpointsIntegratedAuth)
description	string	What this preset is for. Empty when the deployment states none.

list

One ready-made AI agent configuration OVHcloud publishes, offered alongside the templates a caller writes for themselves. Its identifier is what a creation names to build an agent from it, and carries a reserved prefix that distinguishes it from a caller's own template.

Name	Datatype	Description
id	string	Identifier to pass as targetSpec.template.id when creating an agent from this preset
name	string	Human-readable name of the preset
ai_endpoints	boolean	Whether an agent created from this preset uses the OVHcloud AI Endpoints provider preset (wire: aiEndpoints)
ai_endpoints_integrated_auth	boolean	Whether the AI Endpoints credential is minted by this service rather than supplied by the caller (wire: aiEndpointsIntegratedAuth)
description	string	What this preset is for. Empty when the deployment states none.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	template_preset_id, project_id		A preset is a ready-made configuration OVHcloud publishes, offered alongside the templates a caller writes for themselves. Pass its id as targetSpec.template.id on an agent creation to build an agent from it. The identifier carries a reserved prefix, so a client can tell a preset from a template of its own.
list	select	project_id	x_pagination_cursor, x_pagination_size	Presets are ready-made configurations OVHcloud publishes, offered alongside the templates a caller writes for themselves. Pass a preset's id as targetSpec.template.id on an agent creation to build an agent from it. Identifiers carry a reserved prefix, so a client can tell a preset from a template of its own.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
project_id	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
template_preset_id	string	Template preset ID (wire: templatePresetId)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

A preset is a ready-made configuration OVHcloud publishes, offered alongside the templates a caller writes for themselves. Pass its id as targetSpec.template.id on an agent creation to build an agent from it. The identifier carries a reserved prefix, so a client can tell a preset from a template of its own.

SELECT
id,
name,
ai_endpoints,
ai_endpoints_integrated_auth,
description
FROM ovh.public_cloud.ai_agents_preset_templates
WHERE template_preset_id = '{{ template_preset_id }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

Presets are ready-made configurations OVHcloud publishes, offered alongside the templates a caller writes for themselves. Pass a preset's id as targetSpec.template.id on an agent creation to build an agent from it. Identifiers carry a reserved prefix, so a client can tell a preset from a template of its own.

SELECT
id,
name,
ai_endpoints,
ai_endpoints_integrated_auth,
description
FROM ovh.public_cloud.ai_agents_preset_templates
WHERE project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;