Creating Instant APIs

The Wolfram Language has built-in capabilities for creating and deploying APIs on the web and elsewhere.

Basic API Setup

(RefLink[APIFunction, paclet:ref/APIFunction]) — define the parameters and function to execute for the API

(RefLink[CloudDeploy, paclet:ref/CloudDeploy]) — deploy as an active API on the web

(OrangeLink[Handling Parameters », paclet:guide/InterpretingStrings])

(RefLink[Interpreter, paclet:ref/Interpreter]) — specify how parameters should be converted for use in the function

(RefLink[Failure, paclet:ref/Failure]) — object returned if interpretation fails

Controlling API Results

(RefLink[ExportForm, paclet:ref/ExportForm]) — specify a format for results (e.g. "PNG", "CloudCDF", ...)

(RefLink[ResponseForm, paclet:ref/ResponseForm]) — specify a wrapper for the API response (e.g. "JSON")

(RefLink[HTTPResponse, paclet:ref/HTTPResponse]) — specify metadata from the HTTP response (e.g. "StatusCode")

(RefLink[HTTPErrorResponse, paclet:ref/HTTPErrorResponse]) — specify an HTTP error response

Constructing Results

(OrangeLink[Execution Metadata », paclet:guide/CloudExecutionMetadata])

Embedding in External Constructs

(RefLink[EmbedCode, paclet:ref/EmbedCode]) — generate code for embedding API calls in pages, languages, etc.

Managing Instant APIs

(RefLink[CloudObject, paclet:ref/CloudObject]) — symbolic representation of APIs in the cloud

(RefLink[Options, paclet:ref/Options]), (RefLink[SetOptions, paclet:ref/SetOptions]) — find, set options for a deployed API

(RefLink[Permissions, paclet:ref/Permissions]) — permissions for executing or modifying the API

Testing Instant APIs

(RefLink[GenerateHTTPResponse, paclet:ref/GenerateHTTPResponse]) — generate a symbolic HTTP response from an APIFunction