Agents

Add function

Adds a function definition to the agent's tools, allowing it to interface with an external API endpoint.

post/api/agents/{agent}/functions

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

Path parameters

agentstring required

Agent identifier (id or uid).

Request body

namestring nullable required

The name of the function.

descriptionstring nullable required

Describes the purpose of the function to the agent.

urlstring uri nullable required

Url to the external API endpoint.

methodstring nullable

HTTP method to use when calling the endpoint (defaults to GET).

headersobject nullable

Headers to include in the request, e.g. Authorization, Content-Type, User-Agent etc.

parametersunknown

Response

Created

namestring nullable

The name of the function.

descriptionstring nullable

Describes the functions purpose to the agent.

methodstring nullable

The HTTP method to use when calling the endpoint.

urlstring nullable

The API endpoint to call.

headersobject nullable

Headers to include in the request, e.g. Authorization, Content-Type, User-Agent etc.

parametersunknown

Changes

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