The web server provides endpoints to handle opening, creating and editing deep links as well as exporting a copy of your Deep Links history. Below are the details for available endpoints.
Endpoints
GET /open
Opens a deep link specified by the query parameters Either by its display name, or a target URL. Only one is required
Query Parameters:
Key Type Description
target String The deep link URL to open. Example: someapp://some/path.
name String The display name of a saved deep link. If provided, it attempts to find and open the corresponding deep link.
Responses:
200 Success: The deep link was successfully opened.
404 Not Found: No deep link with the given name exists.
POST /open (By name)
Processes and opens an existing Deep Link by its name.
Request Body:
Key Type Description Default Value
name String User-friendly name you assigned to the Deep Link. Required
POST /open create a new DeepLink and Open it
Processes and opens a deep link from a JSON payload.
Request Body:
Key Type Description Default Value
targetUrlString String The deep link URL to be opened. Required
displayName String User-friendly name for the deep link. ""
pinnedColor String A predefined color name for visual pinning. See the list below for accepted values. Random
isPinned Boolean Marks the deep link as pinned. false
mixAudio Boolean Whether to mix audio with other playing audio sources. false
Accepted Values for pinnedColor:
Red
Orange
Yellow
Green
Mint
Teal
Blue
Indigo
Purple
Pink
Brown
Gray
Responses:
200 Success: The deep link was successfully processed and opened.
404 Not Found: No deep link with the given name exists.
400 Bad Request: Required parameters are missing or invalid.
GET /history
Returns a JSON array of all saved deep links, including their attributes.
Response:
200 Success: Returns the list of deep links.
Examples
GET /open
GET /open?target=someapp://some/path
POST /open
POST /open
Content-Type: application/json
{
"targetUrlString": "someapp://path/to/resource",
"displayName": "Example Link",
"pinnedColor": "Blue",
"isPinned": true,
"mixAudio": true
}
