Skip to main content
GET
/
ai
/
integrations
/
{integration_id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const integration = await client.ai.integrations.retrieve('integration_id');

console.log(integration.id);
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
integration = client.ai.integrations.retrieve(
"integration_id",
)
print(integration.id)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
integration, err := client.AI.Integrations.Get(context.TODO(), "integration_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", integration.ID)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.integrations.IntegrationRetrieveParams;
import com.telnyx.sdk.models.ai.integrations.IntegrationRetrieveResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

IntegrationRetrieveResponse integration = client.ai().integrations().retrieve("integration_id");
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

integration = telnyx.ai.integrations.retrieve("integration_id")

puts(integration)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$integration = $client->ai->integrations->retrieve('integration_id');

var_dump($integration);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx ai:integrations retrieve \
--api-key 'My API Key' \
--integration-id integration_id
curl --request GET \
--url https://api.telnyx.com/v2/ai/integrations/{integration_id} \
--header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "logo_url": "<string>",
  "available_tools": [
    "<string>"
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integration_id
string
required

The integration id

Response

Successful Response

id
string
required
name
string
required
display_name
string
required
description
string
required
logo_url
string
required
status
enum<string>
required
Available options:
disconnected,
connected
available_tools
string[]
required