Get an agent

GET

agents

{agent_id_or_name}

Get an agent

curl --request GET \
  --url https://api.guild.ai/v1/agents/{agent_id_or_name}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.guild.ai/v1/agents/{agent_id_or_name}",
  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://api.guild.ai/v1/agents/{agent_id_or_name}"

	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://api.guild.ai/v1/agents/{agent_id_or_name}")

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "agent_type": "GUILD_TYPESCRIPT",
  "description": "<string>",
  "is_public": true,
  "name": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cached_forks_count": 123,
  "cached_installs_count": 123,
  "cached_likes_count": 123,
  "is_pinned": true,
  "moderation_state": "ACTIVE",
  "status": "CREATED",
  "archived_at": "2023-11-07T05:31:56Z",
  "archived_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "avatar_url": "<string>",
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creation_template": "LLM",
  "forked_from_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "generated_description": "<string>",
  "maintainer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived_by": "<unknown>",
  "category": "<unknown>",
  "forks_count": 123,
  "full_name": "<string>",
  "git_url": "<string>",
  "installs_count": 123,
  "is_description_autogenerated": "<unknown>",
  "latest_published_version": "<unknown>",
  "latest_version": "<unknown>",
  "likes_count": 123,
  "maintainer": {},
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "creator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "cached_forks_count": 123,
    "cached_forks_public_count": 123,
    "cached_installs_count": 123,
    "cached_installs_public_count": 123,
    "cached_likes_count": 123,
    "cached_likes_public_count": 123,
    "avatar_url": "<string>",
    "banner_url": "<string>",
    "bio": "<string>",
    "discord_url": "<string>",
    "email_domain": "<string>",
    "full_name": "<string>",
    "github_url": "<string>",
    "linkedin_url": "<string>",
    "threads_url": "<string>",
    "website_url": "<string>",
    "x_url": "<string>",
    "youtube_url": "<string>",
    "member_count": "<unknown>",
    "viewer_membership_id": "<unknown>",
    "viewer_membership_public": "<unknown>",
    "viewer_role": "ADMIN",
    "type": "organization"
  },
  "public_profile_url": "<unknown>",
  "type": "<unknown>",
  "viewer_can_edit": true
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Path Parameters

agent_id_or_name

string

required

Response

Successful response

string<uuid>

created_at

string<date-time>

updated_at

string<date-time>

agent_type

enum<string>

Available options:

GUILD_TYPESCRIPT,

GUILD_NATIVE,

GOOSE,

OPENCLAW,

LANGGRAPH

description

string

Manual description field. Can be empty; the effective description falls back to generated_description.

is_public

boolean

Whether the asset is visible to the community or only its owner.

name

string

Unique name identifying the asset within the owner account.

Maximum string length: 100

owner_id

string<uuid>

The account that owns this entity.

cached_forks_count

integer

A cached version of the forks count. Might not be up to date.

cached_installs_count

integer

A cached version of the installs count. Might not be up to date.

cached_likes_count

integer

A cached version of the likes count. Might not be up to date.

is_pinned

boolean

If true, it means the agent is pinned on the owner's account's profile.

moderation_state

enum<string>

Operator-controlled moderation/curation state. Owners cannot change this; only operators can, via the hub kebab menu or ops tooling.

Available options:

ACTIVE,

DEMOTED,

UNLISTED,

DISABLED,

TAKEN_DOWN

status

enum<string>

Available options:

CREATED,

GIT_REPOSITORY_CREATED,

READY

archived_at

string<date-time> | null

archived_by_id

string<uuid> | null

avatar_url

string | null

Maximum string length: 255

category_id

string<uuid> | null

The category this agent is sorted in.

creation_template

enum<string> | null

If applicable, the template that was selected during the creation of this agent. Note: it doesn't mean the agent is still following the template now.

Available options:

LLM,

AUTO_MANAGED_STATE,

BLANK,

GOOSE,

GUILD_NATIVE,

OPENCLAW,

LANGGRAPH

forked_from_id

string<uuid> | null

If applicable, the ID of the agent version this agent was forked from.

generated_description

string | null

LLM-generated description based on agent code. Regenerated automatically on every commit.

maintainer_id

string<uuid> | null

OPTIONAL. Refers to the person within an organization that is tasked with maintaining the agent.

archived_by

any

category

any

forks_count

integer

Number of times this agent has been forked

full_name

string

Full agent name in format "owner_name/agent_name"

git_url

string

URL to the agent's git repository

installs_count

integer

Number of times this agent has been installed in workspaces

is_description_autogenerated

any

latest_published_version

any

latest_version

any

likes_count

integer

Number of likes this agent has received

maintainer

object | null

Maintainer of the agent (for organization-owned agents)

owner

object

Option 1
Option 2

Show child attributes

public_profile_url

any

type

any

viewer_can_edit

boolean

Whether the current viewer can edit this agent

⌘I

Get an agent

curl --request GET \
  --url https://api.guild.ai/v1/agents/{agent_id_or_name}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.guild.ai/v1/agents/{agent_id_or_name}",
  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://api.guild.ai/v1/agents/{agent_id_or_name}"

	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://api.guild.ai/v1/agents/{agent_id_or_name}")

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "agent_type": "GUILD_TYPESCRIPT",
  "description": "<string>",
  "is_public": true,
  "name": "<string>",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cached_forks_count": 123,
  "cached_installs_count": 123,
  "cached_likes_count": 123,
  "is_pinned": true,
  "moderation_state": "ACTIVE",
  "status": "CREATED",
  "archived_at": "2023-11-07T05:31:56Z",
  "archived_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "avatar_url": "<string>",
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creation_template": "LLM",
  "forked_from_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "generated_description": "<string>",
  "maintainer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived_by": "<unknown>",
  "category": "<unknown>",
  "forks_count": 123,
  "full_name": "<string>",
  "git_url": "<string>",
  "installs_count": 123,
  "is_description_autogenerated": "<unknown>",
  "latest_published_version": "<unknown>",
  "latest_version": "<unknown>",
  "likes_count": 123,
  "maintainer": {},
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "creator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "cached_forks_count": 123,
    "cached_forks_public_count": 123,
    "cached_installs_count": 123,
    "cached_installs_public_count": 123,
    "cached_likes_count": 123,
    "cached_likes_public_count": 123,
    "avatar_url": "<string>",
    "banner_url": "<string>",
    "bio": "<string>",
    "discord_url": "<string>",
    "email_domain": "<string>",
    "full_name": "<string>",
    "github_url": "<string>",
    "linkedin_url": "<string>",
    "threads_url": "<string>",
    "website_url": "<string>",
    "x_url": "<string>",
    "youtube_url": "<string>",
    "member_count": "<unknown>",
    "viewer_membership_id": "<unknown>",
    "viewer_membership_public": "<unknown>",
    "viewer_role": "ADMIN",
    "type": "organization"
  },
  "public_profile_url": "<unknown>",
  "type": "<unknown>",
  "viewer_can_edit": true
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Get Started

Workspaces

Agents

Sessions

Skills

Accounts

Get an agent

Path Parameters

Response