RestApiAction

When to call it and what it does. The agent reads it to decide whether to call, so write it as you would explain it to a person.

What the agent calls the action. Unique within the agent, and none of the names of the agent's own tools: get_datetime, assistant_set_variable_content, or a name starting with assistant_exit_conversation_.

Where the call goes, starting with http:// or https:// written in lowercase and with nothing before it, on a public host. A host that turns out to be internal when it is resolved is not refused here, but every call to it is blocked. A {name} in the path, the query or the fragment is filled with the argument of that name; the scheme and the host take none. Every argument is also sent, as query parameters for GET and DELETE and as the JSON body for the other methods.

Headers that authenticate the call, such as Authorization or X-Api-Key. Encrypted when stored and masked in every answer. A name may not also be in headers.

Headers that hold no secret, such as Accept. Stored and answered as they are sent.

The arguments the agent fills in when it calls the action, as the JSON Schema of each one. A top-level argument cannot be marked required yet: say so in its description.

Stored and answered, but not used. Every call is bounded by the same timeout.