Skip to main content
PATCH
Update an agent's visibility, archive state or pin

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.

Path Parameters

agent_id_or_name
string
required

Body

application/json
is_public
boolean | null
is_archived
boolean | null
is_pinned
boolean | null
avatar_url
string | null
maintainer_id
string<uuid> | null
category
string | null

Category ID or name

tags
string[] | null

Tag names; tags other than Guild's need a category

Response

Successful response

id
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,
ADK
description
string

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

Maximum string length: 8192
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,
ADK
creator_id
string<uuid> | null

The user, agent or API key that created this agent. Null for legacy rows created before creator attribution was recorded.

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.

Maximum string length: 8192
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
creator
any

The user who created this agent.

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
last_updated_by
any

The user who pushed the newest version of this agent.

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
public_profile_url
any
type
any
viewer_can_edit
boolean

Whether the current viewer can edit this agent