Retrieve an agent template

GET

agents

templates

{templateName}

TypeScript SDK

import Tembo from '@tembo-io/sdk';

const client = new Tembo();

const template = await client.agents.templates.retrieve('templateName');

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tembo.io/v1/agents/templates/{templateName}', 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://api.tembo.io/v1/agents/templates/{templateName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.tembo.io/v1/agents/templates/{templateName}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.tembo.io/v1/agents/templates/{templateName}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "addTestCoverage",
  "title": "<string>",
  "description": "<string>",
  "label": "Code Review",
  "instructions": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Hello"
          }
        ]
      }
    ]
  },
  "connectedApps": [
    "<string>"
  ],
  "agent": "<string>",
  "artifactType": "PullRequest",
  "triggers": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "integrationType": "<string>",
      "filters": {
        "projects": [
          "<string>"
        ],
        "boards": [
          "<string>"
        ],
        "statuses": [
          "<string>"
        ],
        "assignedTo": [
          "<string>"
        ],
        "labels": [
          "<string>"
        ],
        "includeNewIssues": true
      }
    }
  ],
  "schedules": [
    "<string>"
  ],
  "requiredParams": [
    "repository"
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

templateName

string

required

Required string length: 1 - 200

Response

Retrieve an agent template

name

enum<string>

required

Available options:

addTestCoverage,

addTestCoverageFromJira,

autoAgentsMdMaintainer,

autoDocsMaintainer,

commitOfTheDay,

customerHealthMonitoringAgent,

deadCodeCleanup,

dependencySweepAgent,

autoFixCi,

autoFixSentryError,

dailySlackChangelog,

duplicateTicketDetector,

fixBugsReportedInSlack,

enrichGithubIssue,

enrichJiraIssue,

enrichLinearIssue,

hubspotCallTaskCoach,

hubspotEmailTaskDrafter,

hubspotTicketToLinearBug,

prDescription,

prReview,

pagePerformanceReport,

prioritizeSentry,

productFaqAgent,

productFinanceAgent,

queryPerformanceReport,

securityFixFromJira,

securityScan,

skillProgressionMap,

slackChannelListener,

slopCop,

staleCodeComments,

stalePullRequestNotifier,

summarizeChangesDaily,

triageNewJiraBug

title

string

required

description

string

required

label

enum<string>

required

Available options:

Code Review,

Productivity,

Documentation,

Reporting,

Monitoring,

Management

instructions

object

required

Instructions for the agent as a rich-text document. Mentions can reference integrations used by the agent.

Show child attributes

Example:

{
  "type": "doc",
  "content": [
    {
      "type": "paragraph",
      "content": [{ "type": "text", "text": "Hello" }]
    }
  ]
}

connectedApps

string[]

required

agent

string

required

artifactType

enum<string> | null

Available options:

PullRequest,

ToolCall,

Plan,

Response,

File,

Service,

Source,

null

triggers

object[]

Show child attributes

schedules

string[]

requiredParams

string[]

Allowed value: "repository"

⌘I

TypeScript SDK

import Tembo from '@tembo-io/sdk';

const client = new Tembo();

const template = await client.agents.templates.retrieve('templateName');

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tembo.io/v1/agents/templates/{templateName}', 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://api.tembo.io/v1/agents/templates/{templateName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.tembo.io/v1/agents/templates/{templateName}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.tembo.io/v1/agents/templates/{templateName}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "name": "addTestCoverage",
  "title": "<string>",
  "description": "<string>",
  "label": "Code Review",
  "instructions": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Hello"
          }
        ]
      }
    ]
  },
  "connectedApps": [
    "<string>"
  ],
  "agent": "<string>",
  "artifactType": "PullRequest",
  "triggers": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "integrationType": "<string>",
      "filters": {
        "projects": [
          "<string>"
        ],
        "boards": [
          "<string>"
        ],
        "statuses": [
          "<string>"
        ],
        "assignedTo": [
          "<string>"
        ],
        "labels": [
          "<string>"
        ],
        "includeNewIssues": true
      }
    }
  ],
  "schedules": [
    "<string>"
  ],
  "requiredParams": [
    "repository"
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}