Interacting with the SparkAI service occurs through a web-based HTTP API. New engagement requests are made via a REST-based API, and can be polled for status updates. If a requestor requires immediate notification on any status change, the SparkAI service can push a resolution via a provided webhook URL.

New engagement requests can be made with an associated program, which contains metadata and context about the engagement such as a set of instructions. If a program_name is not provided with a request, SparkAI will still make a best effort at creating a resolution. These requests should be made with clear instructions.

In addition to the content of the request, all that is needed to create a new engagement request is a supplied program_name or instructions.

All HTTP API calls follow the form of<path>.