TRANXACT.AI Help

Agentic AI · Templates

Agent Templates

Working agents for problems most businesses have — finding leads, finding a cheaper supplier, watching the job boards. Each one is a whole thing: prompt, tools, graph, trigger and what it costs to run. Everything created from one starts as a draft that can only suggest, with its trigger disarmed.

Type REST3 operationsBase path /api/agentic/templates

Download specification (OpenAPI 3.1) Screen: Agent Templates

Overview

PackageAgentic AI
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Agentic AI › Agent Templates on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

3 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/agentic/templatesRead agent templates

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/agentic/templates" \
  -H "Authorization: Bearer $TOKEN"
GET/api/agentic/templates/{key}Read agent templates

Path parameters

NameTypeDescription
keystring (uuid)The record's key, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/agentic/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/templates/{code}/useUse

Path parameters

NameTypeDescription
codestring (uuid)The record's code, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

name, runAsUserId

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/agentic/templates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/use" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"value","runAsUserId":"value"}'

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Agentic AI › Agent Templates for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.