Agents

Get agent

Get AI agent with specified identifier.

get/api/agents/{agent}

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/agents/{agent}
  • Auth: none declared

Path parameters

agentstring required

Agent identifier (id or uid).

Query parameters

trashedboolean

true to return agent even if trashed.

Response

OK

uidstring nullable
namestring nullable
providerstring nullable

The agent provider.

modelstring nullable

The model to use for the agent, e.g. "gemini-2.0-flash".

instructionsstring nullable

The prompt or system instructions for the agent.

functionsstring[] nullable

Name of agent's functions.

web_searchboolean nullable

Can the agent use web search or not.

avatar_urlstring nullable

Url to profile picture for agent.

commentstring nullable
tagsstring[] nullable
metadataobject nullable
created_atstring date-time nullable
updated_atstring date-time nullable
is_agentboolean

Indicates that this is an agent user.

is_trashedboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.