Documentation menu

Templates

2 operations.

MethodEndpointDescription
GET/api/v1/templatesSearch the template library by keyword
GET/api/v1/templates/{templateId}Fetch a template and its Agent revision graph by id

Search the template library by keyword

GET /api/v1/templates

Sessions must specify organizationId to select their catalog audience. Organization-scoped credentials may omit it.

Parameters

query

NameTypeRequiredDescription
organizationIdstringoptionalSelects the organization whose membership determines the template audience. Required for sessions. Organization-scoped credentials may omit it.
qstringoptionalSearches the template library using this text query. Applies to Search the template library by keyword.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to Search the template library by keyword.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to Search the template library by keyword.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — templates: array<object> (required); pagination: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)

Fetch a template and its Agent revision graph by id

GET /api/v1/templates/{templateId}

Sessions must specify organizationId to select their catalog audience. Organization-scoped credentials may omit it.

Parameters

path

NameTypeRequiredDescription
templateIdstringrequiredIdentifies the template being addressed. Applies to Fetch a template and its Agent revision graph by id.

query

NameTypeRequiredDescription
organizationIdstringoptionalSelects the organization whose membership determines the template audience. Required for sessions. Organization-scoped credentials may omit it.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)