a13nDocs
API referenceConnections

Define Connection Tools

Read up to five exact definitions. Oversized values provide a versioned fragment reference.

GET/api/v1/connections/{connection_id}/tools/definitions

Read up to five exact definitions. Oversized values provide a versioned fragment reference.

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

connection_id*Connection Id

Query Parameters

name*array<string>

Exact names; repeat name to select up to five definitions.

Items1 <= items <= 5
offset?|null
limit?Limit

Maximum Unicode code points in this fragment.

Range1 <= value <= 4000
Default4000
version?|

Content version from the first read; required after offset 0.

query?|

Case-sensitive literal text search.

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/connections/string/tools/definitions?name=string"
{  "items": [    {      "definition": {        "property1": null,        "property2": null      },      "name": "string"    }  ],  "missing": [    "string"  ],  "oversized": [    {      "instruction": "Read this endpoint with one name, offset=0 and limit=4000, then continue with version and next_offset.",      "name": "string",      "size_chars": 0,      "version": "string"    }  ]}