TRANXACT.AI Help

Agentic AI · Connect

Agent Connections

The MCP servers, APIs, webhooks and other agentic platforms this company reaches. An MCP server describes its own tools, so the catalog is the server answer rather than somebody typing.

Type REST9 operationsBase path /api/agentic/connectionsPublished as /api/v1/connections

Download specification (OpenAPI 3.1) Screen: Agent Connections

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 Connections 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.connections · 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

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

GET/api/agentic/connectionsList agent connections

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",
      "code": "COD-000001",
      "name": "Example",
      "name_local": "Example",
      "kind": "text",
      "vendor": "text",
      "description": "text",
      "base_url": "https://example.com",
      "command": "text",
      "command_args": [],
      "protocol_version": "text",
      "auth_type": "text",
      "credential_cipher": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "kind": "text",
  "vendor": "text",
  "description": "text",
  "base_url": "https://example.com",
  "command": "text",
  "command_args": [],
  "protocol_version": "text",
  "auth_type": "text",
  "credential_cipher": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
name_localtextNoLocal name
kindtextNoProtocol
vendortextNoPlatform — Only picks sensible defaults. A platform nobody has heard of works identically.
descriptiontextNoWhat it is for
base_urltextNoAddress — Public hosts only. Loopback, private ranges and link-local are refused — that is where cloud metadata lives.
commandtextNoCommand
command_args_textNoCommand args
protocol_versiontextNoProtocol version
auth_typetextNoAuthentication
auth_headertextNoHeader name
token_urltextNoToken endpoint
scopes_textNoScopes
default_headersjsonbNoExtra headers — Tenant ids and API versions. Not credentials — those go through the credential button.
timeout_msintegerNoTimeout (ms)
rate_per_minuteintegerNoCalls per minute
max_concurrentintegerNoAt once
access_modetextNoAccess — A read-only connection cannot be used for a write, whatever a tool says about itself.
Allowed: read_only read_write
requires_approvalbooleanNoEvery call asks a person
statustextNoStatus
Allowed: draft testing active suspended error retired
notestextNoNotes
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "kind": "text",
  "vendor": "text",
  "description": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "kind": "text",
  "vendor": "text",
  "description": "text",
  "base_url": "https://example.com",
  "command": "text",
  "command_args": [],
  "protocol_version": "text",
  "auth_type": "text",
  "credential_cipher": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/agentic/connections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","name_local":"Example","kind":"text","vendor":"text","description":"text"}'
PUT/api/agentic/connections/{id}Change a connections

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
codetextYesCode
nametextYesName
name_localtextNoLocal name
kindtextNoProtocol
vendortextNoPlatform — Only picks sensible defaults. A platform nobody has heard of works identically.
descriptiontextNoWhat it is for
base_urltextNoAddress — Public hosts only. Loopback, private ranges and link-local are refused — that is where cloud metadata lives.
commandtextNoCommand
command_args_textNoCommand args
protocol_versiontextNoProtocol version
auth_typetextNoAuthentication
auth_headertextNoHeader name
token_urltextNoToken endpoint
scopes_textNoScopes
default_headersjsonbNoExtra headers — Tenant ids and API versions. Not credentials — those go through the credential button.
timeout_msintegerNoTimeout (ms)
rate_per_minuteintegerNoCalls per minute
max_concurrentintegerNoAt once
access_modetextNoAccess — A read-only connection cannot be used for a write, whatever a tool says about itself.
Allowed: read_only read_write
requires_approvalbooleanNoEvery call asks a person
statustextNoStatus
Allowed: draft testing active suspended error retired
notestextNoNotes
is_activebooleanNoActive

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "name_local": "Example",
  "kind": "text",
  "vendor": "text",
  "description": "text",
  "base_url": "https://example.com",
  "command": "text",
  "command_args": [],
  "protocol_version": "text",
  "auth_type": "text",
  "credential_cipher": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/agentic/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/agentic/connections/{id}Delete a connections

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/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/connections/{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/connections/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/connections/{id}/credentialCredential

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):

token, key, value, password

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/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credential" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"token":"value","key":"value","value":"value","password":"value"}'
POST/api/agentic/connections/{id}/testTest

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/connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
  -H "Authorization: Bearer $TOKEN"
POST/api/agentic/connections/{id}/discoverDiscover

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

Data model

Every field of a connections, 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
codetextread, writeCode
nametextread, writeName
name_localtextread, writeLocal name
kindtextread, writeProtocol
vendortextread, writePlatform — Only picks sensible defaults. A platform nobody has heard of works identically.
descriptiontextread, writeWhat it is for
base_urltextread, writeAddress — Public hosts only. Loopback, private ranges and link-local are refused — that is where cloud metadata lives.
commandtextread, writeCommand
command_args_textread, writeCommand args
protocol_versiontextread, writeProtocol version
auth_typetextread, writeAuthentication
credential_cipherbytearead onlyCredential cipher
credential_last4textread onlyCredential last4
auth_headertextread, writeHeader name
token_urltextread, writeToken endpoint
scopes_textread, writeScopes
default_headersjsonbread, writeExtra headers — Tenant ids and API versions. Not credentials — those go through the credential button.
timeout_msintegerread, writeTimeout (ms)
rate_per_minuteintegerread, writeCalls per minute
max_concurrentintegerread, writeAt once
access_modetextread, writeAccess — A read-only connection cannot be used for a write, whatever a tool says about itself.
Allowed: read_only read_write
requires_approvalbooleanread, writeEvery call asks a person
statustextread, writeStatus
Allowed: draft testing active suspended error retired
last_checked_attimestamp with time zoneread onlyLast checked at
last_errortextread onlyLast error
discovered_attimestamp with time zoneread onlyDiscovered at
tool_countintegerread onlyTool count
notestextread, writeNotes
is_activebooleanread, writeActive
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 › Agent Connections 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.