List plugin connections

curl --request GET \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections

const options = {method: 'GET'};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": {
    "pluginConnections": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "deadAt": "2023-11-07T05:31:56Z",
        "disabled": true,
        "lastAssertAt": "2023-11-07T05:31:56Z",
        "lastAssertStatus": "PENDING",
        "lastHealthCheckAt": "2023-11-07T05:31:56Z",
        "lastHealthStatus": "HEALTHY",
        "nextAssertAt": "2023-11-07T05:31:56Z",
        "nextHealthCheckAt": "2023-11-07T05:31:56Z",
        "plugin": {
          "pluginDescription": "<string>",
          "pluginID": "<string>",
          "pluginIcon": "<string>",
          "pluginMCPSettings": {
            "mcpRequest": {
              "address": "<string>",
              "headers": {},
              "method": "<string>"
            },
            "method": "<string>"
          },
          "pluginName": "<string>",
          "pluginPresentations": [
            {
              "adapter": "<string>",
              "pluginCategory": "<string>",
              "pluginColor": "<string>",
              "pluginDescription": "<string>",
              "pluginIcon": "<string>",
              "pluginName": "<string>",
              "pluginSlug": "<string>",
              "pluginSummary": "<string>",
              "presentationKey": "<string>"
            }
          ],
          "pluginURN": "<string>",
          "pluginVariables": [
            {
              "variableDescription": "<string>",
              "variableKey": "<string>",
              "variableLabel": "<string>",
              "variableOptions": [
                {
                  "label": "<string>",
                  "value": "<string>"
                }
              ],
              "variableType": "string"
            }
          ]
        },
        "pluginConnectionID": "<string>",
        "pluginConnectionLabel": "<string>",
        "pluginURN": "<string>",
        "settings": {},
        "sickAt": "2023-11-07T05:31:56Z",
        "tenantID": "<string>",
        "token": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Plugins

List plugin connections

Lists every plugin the tenant has connected, each with the catalog entry it installs joined in — the data behind the installed-plugins screen. Disabled connections are included (so the screen can offer to switch them back on); deleted ones are not.

Each entry carries the connection’s own token and its settings, which hold the provider credentials — same payload the core-api handler returned. Anyone authorized for the tenant can therefore read them.

GET

tenants

{tenantID}

plugins

connections

List plugin connections

curl --request GET \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections

const options = {method: 'GET'};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/plugins/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": {
    "pluginConnections": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "deadAt": "2023-11-07T05:31:56Z",
        "disabled": true,
        "lastAssertAt": "2023-11-07T05:31:56Z",
        "lastAssertStatus": "PENDING",
        "lastHealthCheckAt": "2023-11-07T05:31:56Z",
        "lastHealthStatus": "HEALTHY",
        "nextAssertAt": "2023-11-07T05:31:56Z",
        "nextHealthCheckAt": "2023-11-07T05:31:56Z",
        "plugin": {
          "pluginDescription": "<string>",
          "pluginID": "<string>",
          "pluginIcon": "<string>",
          "pluginMCPSettings": {
            "mcpRequest": {
              "address": "<string>",
              "headers": {},
              "method": "<string>"
            },
            "method": "<string>"
          },
          "pluginName": "<string>",
          "pluginPresentations": [
            {
              "adapter": "<string>",
              "pluginCategory": "<string>",
              "pluginColor": "<string>",
              "pluginDescription": "<string>",
              "pluginIcon": "<string>",
              "pluginName": "<string>",
              "pluginSlug": "<string>",
              "pluginSummary": "<string>",
              "presentationKey": "<string>"
            }
          ],
          "pluginURN": "<string>",
          "pluginVariables": [
            {
              "variableDescription": "<string>",
              "variableKey": "<string>",
              "variableLabel": "<string>",
              "variableOptions": [
                {
                  "label": "<string>",
                  "value": "<string>"
                }
              ],
              "variableType": "string"
            }
          ]
        },
        "pluginConnectionID": "<string>",
        "pluginConnectionLabel": "<string>",
        "pluginURN": "<string>",
        "settings": {},
        "sickAt": "2023-11-07T05:31:56Z",
        "tenantID": "<string>",
        "token": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Path Parameters

tenantID

string<uuid>

required

The tenant whose plugin connections are being listed.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Response for status 200.

data

object

required

Show child attributes

⌘I

Real Time API

Services API

Helpdesk API

List plugin connections

Path Parameters

Response