Retrieve an agent - Tembo Docs

GET

agents

{agentId}

Retrieve an agent

curl --request GET \
  --url https://api.tembo.io/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.tembo.io/v1/agents/{agentId}', 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/{agentId}",
  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/{agentId}"

	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/{agentId}")

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "key": "<string>",
  "sandboxSize": "nano",
  "projectId": "<string>",
  "templateId": "<string>",
  "script": "<string>",
  "artifactType": "PullRequest",
  "autoDetectRepositories": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "enabledAt": "2023-11-07T05:31:56Z",
  "organizationId": "<string>",
  "organizationName": "<string>",
  "createdBy": "<string>",
  "jsonContent": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Review the latest changes."
          }
        ]
      }
    ]
  },
  "agent": "<string>",
  "agentOptions": {
    "reasoningLevel": "high",
    "mode": "planning",
    "speed": "fast",
    "goal": {
      "enabled": true,
      "objective": "Review the pull request"
    }
  },
  "mcpServers": [
    "<string>"
  ],
  "userState": {},
  "codeRepositories": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": "<string>",
      "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "integrationType": "<string>"
    }
  ],
  "lastRun": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sessionId": "<string>",
    "status": "<string>",
    "runTime": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "errorMessage": "<string>"
  },
  "runCount": 1,
  "scheduleCount": 1,
  "triggerCount": 1,
  "hasPausedSchedule": true,
  "hasPausedTrigger": true,
  "integrationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "integrationTypes": [
    "<string>"
  ]
}

{
  "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

agentId

string<uuid>

required

Response

Retrieve an agent

string<uuid>

required

name

string

required

key

string | null

required

sandboxSize

enum<string> | null

required

Available options:

nano,

micro,

small,

medium,

large,

xl,

xxl,

ultra,

null

projectId

string | null

required

templateId

string | null

required

script

string | null

required

artifactType

enum<string> | null

required

Available options:

PullRequest,

ToolCall,

Plan,

Response,

File,

Service,

Source,

null

autoDetectRepositories

boolean

default:true

required

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

archivedAt

string<date-time> | null

required

enabledAt

string<date-time> | null

required

organizationId

string | null

required

Required string length: 1 - 255

organizationName

string | null

required

createdBy

string | null

required

jsonContent

object | null

required

Agent document JSON. This normally contains a TipTap document rooted at { "type": "doc", "content": [...] }; unknown and future nodes, marks, attributes, and extensions are preserved.

Show child attributes

Example:

{
  "type": "doc",
  "content": [
    {
      "type": "paragraph",
      "content": [
        {
          "type": "text",
          "text": "Review the latest changes."
        }
      ]
    }
  ]
}

agent

string | null

required

agentOptions

object

required

Runtime-specific Agent options. Common options include reasoningLevel, mode, speed, and goal; unknown options are preserved and validated by the selected Agent runtime when used.

Show child attributes

Example:

{
  "reasoningLevel": "high",
  "mode": "planning",
  "speed": "fast",
  "goal": {
    "enabled": true,
    "objective": "Review the pull request"
  }
}

mcpServers

string[]

required

Maximum array length: 100

Required string length: 1 - 200

userState

object | null

required

Show child attributes

codeRepositories

object[]

required

Maximum array length: 250

Show child attributes

lastRun

object | null

required

Show child attributes

runCount

integer

required

Required range: x >= 0

scheduleCount

integer

required

Required range: x >= 0

triggerCount

integer

required

Required range: x >= 0

hasPausedSchedule

boolean

required

hasPausedTrigger

boolean

required

integrationIds

string<uuid>[]

required

integrationTypes

string[]

required

⌘I

Retrieve an agent

curl --request GET \
  --url https://api.tembo.io/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.tembo.io/v1/agents/{agentId}', 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/{agentId}",
  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/{agentId}"

	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/{agentId}")

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "key": "<string>",
  "sandboxSize": "nano",
  "projectId": "<string>",
  "templateId": "<string>",
  "script": "<string>",
  "artifactType": "PullRequest",
  "autoDetectRepositories": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "enabledAt": "2023-11-07T05:31:56Z",
  "organizationId": "<string>",
  "organizationName": "<string>",
  "createdBy": "<string>",
  "jsonContent": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Review the latest changes."
          }
        ]
      }
    ]
  },
  "agent": "<string>",
  "agentOptions": {
    "reasoningLevel": "high",
    "mode": "planning",
    "speed": "fast",
    "goal": {
      "enabled": true,
      "objective": "Review the pull request"
    }
  },
  "mcpServers": [
    "<string>"
  ],
  "userState": {},
  "codeRepositories": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": "<string>",
      "integrationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "integrationType": "<string>"
    }
  ],
  "lastRun": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sessionId": "<string>",
    "status": "<string>",
    "runTime": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "errorMessage": "<string>"
  },
  "runCount": 1,
  "scheduleCount": 1,
  "triggerCount": 1,
  "hasPausedSchedule": true,
  "hasPausedTrigger": true,
  "integrationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "integrationTypes": [
    "<string>"
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}