API Reference

Introspect connector resources

POST /api/connectors/{id}/introspect

Returns available resources (tables, collections, entities, files) and optionally column/field schema for a specific resource.

Operation IDintrospectConnector

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

Content typeapplication/json

requestobject

10 properties

resourcestring

If provided, returns column info for this resource instead of listing resources

integrated_account_idstring

Truto only — integrated account whose resources to list

surfacestring

Truto only — capability surface filter

Allowed values: all, unified, proxy

delimiterstring

CSV only — field delimiter/separator override for column introspection. Use "\t" or "tab" for tab-separated files.

separatorstring

CSV only — alias for delimiter.

limitinteger

Truto account list page size (default 50)

Minimum: 1
Maximum: 100

cursorstring

Truto account list pagination cursor (next_cursor token)

qstring

Truto account list search (id prefix or tenant_id substring)

integrationstring

Truto account list filter by integration name (e.g. gorgias)

refreshboolean

Dynamics 365 only — discard the connector's cached entity metadata and refetch the schema from the D365 metadata API

Success response body

200Introspection result

Introspection result

Content typeapplication/json

responseobject

6 properties

resourcesarray<object>

Array items

itemobject

2 properties

namestring

typestring

columnsarray<object>

Array items

itemobject

3 properties

namestring

typestring

nullableboolean

accountsarray<object>

Array items

itemobject

5 properties

idstring

labelstring | null

Nullable: yes

tenant_idstring

integration_namestring

statusstring | null

Nullable: yes

next_cursorstring | null

Truto integrated account list — cursor for the next page

Nullable: yes

fallbackboolean

True when resources is a hardcoded fallback list because the live schema fetch failed (Dynamics 365)

schema_errorstring

Error message from the underlying schema fetch when it failed (Dynamics 365)

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

500Introspection failed

Introspection failed

No response content schema is documented.

Code examples

curl --request POST \
  --url 'https://your-envoy.example.com/api/connectors/YOUR_ID/introspect' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "resource": "string",
  "integrated_account_id": "string",
  "surface": "all",
  "delimiter": "string",
  "separator": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/connectors/YOUR_ID/introspect", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "resource": "string",
    "integrated_account_id": "string",
    "surface": "all",
    "delimiter": "string",
    "separator": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);