YOUR AI PLATE HANDBOOK

REST & authentication

Manifest fields, request mapping, authentication, and health checks.

Desktop source reviewed October 5, 2026

On this page

Connector manifest reference

Field	Contract
manifest_type	Use connector. Keep plugin-only fields out of this package.
id / name	Required. ID accepts letters, numbers, underscore, and hyphen.
type	custom_rest, custom_ws, blender, obs, comfyui, or godot.
connection.protocol	http, https, ws, or wss.
connection.host / port	Hostname without a scheme; use an integer port 1–65535.
connection.authType / authToken	none, bearer, apikey; basic appears in the type but is not automatically implemented in custom REST.
connection.customHeaders	Literal headers, including explicit Authorization if needed.
options.test_path	Health-check path, default /.
endpoints	name, description, method, path, and parametersJsonSchema.
companion_script	Optional packaged companion filename; start it separately.

An endpoint named get_note in notes_bridge becomes notes_bridge_get_note.
Path tokens use single braces: /notes/{id}. Matching top-level arguments are URL-encoded and removed from the request body.
Non-GET requests serialize args.payload || args as JSON after removing substituted path arguments.
GET arguments are not automatically converted to a query string. Declare query placeholders in the path, such as /search?q={query}.
Custom endpoints use a 10-second timeout. Health tests use GET and a 3.5-second timeout.
Successful JSON responses return the parsed object; non-JSON responses become { response: text }. Failures return an error object.

Mode	Header / requirement
bearer	Authorization: Bearer <authToken>
apikey	X-API-Key: <authToken>
customHeaders	Use for service-specific header names.
basic	No automatic encoding in this path; provide an explicit Authorization header if the service requires it.

Implementation sources

Paths in your AI Plate source checkout: