TRANXACT.AI Help

Agentic AI · Connect

Discovered Tools

What each connection turned out to be able to do. A tool the server no longer offers is disabled rather than deleted, because deleting it would take the grants and the call history with it.

Type REST7 operationsBase path /api/agentic/connection-toolsPublished as /api/v1/connection-tools

Download specification (OpenAPI 3.1) Screen: Discovered Tools

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 › Discovered Tools 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.
Tableagent.connection_tools · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/agentic/connection-toolsList discovered tools

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tool_name": "Example",
      "title": "Example",
      "description": "text",
      "input_schema": {},
      "output_schema": {},
      "http_method": "text",
      "http_path": "text",
      "is_write": true,
      "is_destructive": true,
      "is_idempotent": true,
      "is_enabled": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/agentic/connection-tools?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/agentic/connection-tools/{id}Read one connection tool

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_name": "Example",
  "title": "Example",
  "description": "text",
  "input_schema": {},
  "output_schema": {},
  "http_method": "text",
  "http_path": "text",
  "is_write": true,
  "is_destructive": true,
  "is_idempotent": true,
  "is_enabled": true
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/agentic/connection-tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/connection-toolsCreate a connection tool

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
is_writebooleanNoChanges data — Inferred from the name where the server did not say. Correct it here and a rediscovery will not undo the correction.
is_destructivebooleanNoDestructive
is_enabledbooleanNoEnabled
requires_approvalbooleanNoAlways ask a person
cost_hintnumericNoCosts about

Sample body

{
  "is_write": true,
  "is_destructive": true,
  "is_enabled": true,
  "requires_approval": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_name": "Example",
  "title": "Example",
  "description": "text",
  "input_schema": {},
  "output_schema": {},
  "http_method": "text",
  "http_path": "text",
  "is_write": true,
  "is_destructive": true,
  "is_idempotent": true,
  "is_enabled": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/agentic/connection-tools" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"is_write":true,"is_destructive":true,"is_enabled":true,"requires_approval":true}'
PUT/api/agentic/connection-tools/{id}Change a connection tool

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
is_writebooleanNoChanges data — Inferred from the name where the server did not say. Correct it here and a rediscovery will not undo the correction.
is_destructivebooleanNoDestructive
is_enabledbooleanNoEnabled
requires_approvalbooleanNoAlways ask a person
cost_hintnumericNoCosts about

Sample body

{
  "is_write": true,
  "is_destructive": true
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "connection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tool_name": "Example",
  "title": "Example",
  "description": "text",
  "input_schema": {},
  "output_schema": {},
  "http_method": "text",
  "http_path": "text",
  "is_write": true,
  "is_destructive": true,
  "is_idempotent": true,
  "is_enabled": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/agentic/connection-tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"is_write":true,"is_destructive":true}'
DELETE/api/agentic/connection-tools/{id}Delete a connection tool

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/agentic/connection-tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/connection-tools/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

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

overrides, preview, withLines

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/connection-tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/agentic/connection-tools/{id}/publishPublish

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

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/connection-tools/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/publish" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a connection tool, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
connection_iduuidread onlyConnection id
tool_nametextread onlyTool name
titletextread onlyTitle
descriptiontextread onlyDescription
input_schemajsonbread onlyInput schema
output_schemajsonbread onlyOutput schema
http_methodtextread onlyHttp method
http_pathtextread onlyHttp path
is_writebooleanread, writeChanges data — Inferred from the name where the server did not say. Correct it here and a rediscovery will not undo the correction.
is_destructivebooleanread, writeDestructive
is_idempotentbooleanread onlyIs idempotent
is_enabledbooleanread, writeEnabled
requires_approvalbooleanread, writeAlways ask a person
cost_hintnumericread, writeCosts about
last_seen_attimestamp with time zoneread onlyLast seen at
call_countbigintread onlyCall count
error_countbigintread onlyError count
avg_msintegerread onlyAvg ms
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

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 › Discovered Tools 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.