Agents

Create agent

Create AI agent.

post/api/agents

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
  • Auth: none declared

Request body

uidstring nullable required

Unique identifier (cannot contain whitespace and must contain at least one non-digit).

namestring nullable required

Agent name. Used in listings, @mentions etc.

providerstring nullable required

The AI provider for the agent, must be one of anthropic, gemini, kapa, openai or weavy.

modelstring nullable required

The model to use for the agent, e.g. "gpt-5.4-mini" or "claude-sonnet-4-6" etc.

instructionsstring nullable

High-level system instructions describing the desired agent behavior, e.g. main objectives, tone, response style etc.

web_searchboolean nullable

Allow the agent to search the web and answer questions with up-to-date information beyond its knowledge cutoff.

picturestring nullable

Profile picture. Can be a public URL, a base64 encoded data URI or a blob id.

directoriesstring[] nullable

User directories for the agent (id or name).

commentstring nullable

Comment or other application-specific information about the agent.

tagsstring[] nullable

A list of tags to associate with the agent.

metadataobject nullable

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

Response

Created

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.