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.
/api/agentic/connectionsPublished as /api/v1/connectionsDownload specification (OpenAPI 3.1) Screen: Agent Connections
Overview
| Package | Agentic AI |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | agent.connections · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
kind | text | No | Protocol |
vendor | text | No | Platform — Only picks sensible defaults. A platform nobody has heard of works identically. |
description | text | No | What it is for |
base_url | text | No | Address — Public hosts only. Loopback, private ranges and link-local are refused — that is where cloud metadata lives. |
command | text | No | Command |
command_args | _text | No | Command args |
protocol_version | text | No | Protocol version |
auth_type | text | No | Authentication |
auth_header | text | No | Header name |
token_url | text | No | Token endpoint |
scopes | _text | No | Scopes |
default_headers | jsonb | No | Extra headers — Tenant ids and API versions. Not credentials — those go through the credential button. |
timeout_ms | integer | No | Timeout (ms) |
rate_per_minute | integer | No | Calls per minute |
max_concurrent | integer | No | At once |
access_mode | text | No | Access — A read-only connection cannot be used for a write, whatever a tool says about itself. Allowed: read_only read_write |
requires_approval | boolean | No | Every call asks a person |
status | text | No | Status Allowed: draft testing active suspended error retired |
notes | text | No | Notes |
is_active | boolean | No | Active |
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
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
kind | text | No | Protocol |
vendor | text | No | Platform — Only picks sensible defaults. A platform nobody has heard of works identically. |
description | text | No | What it is for |
base_url | text | No | Address — Public hosts only. Loopback, private ranges and link-local are refused — that is where cloud metadata lives. |
command | text | No | Command |
command_args | _text | No | Command args |
protocol_version | text | No | Protocol version |
auth_type | text | No | Authentication |
auth_header | text | No | Header name |
token_url | text | No | Token endpoint |
scopes | _text | No | Scopes |
default_headers | jsonb | No | Extra headers — Tenant ids and API versions. Not credentials — those go through the credential button. |
timeout_ms | integer | No | Timeout (ms) |
rate_per_minute | integer | No | Calls per minute |
max_concurrent | integer | No | At once |
access_mode | text | No | Access — A read-only connection cannot be used for a write, whatever a tool says about itself. Allowed: read_only read_write |
requires_approval | boolean | No | Every call asks a person |
status | text | No | Status Allowed: draft testing active suspended error retired |
notes | text | No | Notes |
is_active | boolean | No | Active |
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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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, passwordResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
code | text | read, write | Code |
name | text | read, write | Name |
name_local | text | read, write | Local name |
kind | text | read, write | Protocol |
vendor | text | read, write | Platform — Only picks sensible defaults. A platform nobody has heard of works identically. |
description | text | read, write | What it is for |
base_url | text | read, write | Address — Public hosts only. Loopback, private ranges and link-local are refused — that is where cloud metadata lives. |
command | text | read, write | Command |
command_args | _text | read, write | Command args |
protocol_version | text | read, write | Protocol version |
auth_type | text | read, write | Authentication |
credential_cipher | bytea | read only | Credential cipher |
credential_last4 | text | read only | Credential last4 |
auth_header | text | read, write | Header name |
token_url | text | read, write | Token endpoint |
scopes | _text | read, write | Scopes |
default_headers | jsonb | read, write | Extra headers — Tenant ids and API versions. Not credentials — those go through the credential button. |
timeout_ms | integer | read, write | Timeout (ms) |
rate_per_minute | integer | read, write | Calls per minute |
max_concurrent | integer | read, write | At once |
access_mode | text | read, write | Access — A read-only connection cannot be used for a write, whatever a tool says about itself. Allowed: read_only read_write |
requires_approval | boolean | read, write | Every call asks a person |
status | text | read, write | Status Allowed: draft testing active suspended error retired |
last_checked_at | timestamp with time zone | read only | Last checked at |
last_error | text | read only | Last error |
discovered_at | timestamp with time zone | read only | Discovered at |
tool_count | integer | read only | Tool count |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Agentic AI › Agent Connections for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.