SWAIG function signature request

Sent once per SWAIG.includes entry when an AI agent loads, to discover the functions your server hosts. Every way of building an agent sends it — SWML you write yourself, SWML a Server SDK generates, or an agent you configure in your Dashboard — because they all resolve includes the same way.

Reply with the function definitions you host, each shaped like an entry in SWAIG.functions — function, description, and parameters. Three forms are accepted:

an array of definitions, the usual one;
a single definition on its own;
an object {functions, defaults}, where defaults sets SWAIG defaults across the definitions it carries — useful when they share a web_hook_url or auth.

Every definition you return is registered, whether or not it was named in the request’s functions list.

This is not the payload a function call sends. It goes to the includes entry’s url, using auth_user and auth_password when set. Your endpoint can also receive it outside of a call, as a check that it answers, so answer it the same way. When your project has a signing key, the request carries an X-SignalWire-Signature header you can verify.

Sent once per [`SWAIG.includes`](/docs/swml/reference/calling/ai/swaig/includes) entry when an AI agent loads, to discover the functions your server hosts. Every way of building an agent sends it — SWML you write yourself, SWML a Server SDK generates, or an agent you configure in your Dashboard — because they all resolve `includes` the same way. Reply with the function definitions you host, each shaped like an entry in [`SWAIG.functions`](/docs/swml/reference/calling/ai/swaig/functions#properties) — `function`, `description`, and `parameters`. Three forms are accepted: - an array of definitions, the usual one; - a single definition on its own; - an object `{functions, defaults}`, where `defaults` sets SWAIG defaults across the definitions it carries — useful when they share a `web_hook_url` or auth. Every definition you return is registered, whether or not it was named in the request's `functions` list. This is not the payload a function call sends. It goes to the `includes` entry's `url`, using `auth_user` and `auth_password` when set. Your endpoint can also receive it outside of a call, as a check that it answers, so answer it the same way. When your project has a signing key, the request carries an `X-SignalWire-Signature` header you can verify.

Payload

The payload of this webhook request is an object.

actionstringRequired

What the request is asking of you. Always get_signature.

functionslist of stringsRequired

The function names the includes entry asked for. This list can be empty, and it does not limit your reply: every definition you return is registered, whether or not it is named here.

content_typestringRequired

The content type of the request body. Always text/swaig.

content_dispositionstringRequired

How the body is delivered. Always function signature request.

versionstringRequired

The SWAIG protocol version.

meta_dataobjectOptional

The meta_data you set on the includes entry. Omitted when you set none.

meta_data_tokenstringOptional

The token scoping meta_data. Present on the check your endpoint can receive outside of a call, where it is a fixed value with nothing to interpret, and absent during a call.

project_idstringOptional

Your project ID, when available.

space_idstringOptional

Your Space ID, when available.

Response

200

Webhook received

Reply with the function definitions you host, each shaped like an entry in SWAIG.functions — function, description, and parameters. Three forms are accepted:

an array of definitions, the usual one;
a single definition on its own;
an object {functions, defaults}, where defaults sets SWAIG defaults across the definitions it carries — useful when they share a web_hook_url or auth.

Every definition you return is registered, whether or not it was named in the request’s functions list.

1	{
2	"action": "get_signature",
3	"functions": [
4	"get_weather"
5	],
6	"content_type": "text/swaig",
7	"content_disposition": "function signature request",
8	"version": "2.0"
9	}