Invoke CloudFunctions

This API is used to run various tasks: run sample, run analyze, run CloudFunction.

The target parameter has two kinds of values:

• Cloud Function ID (e.g. MARVIZPLOT). In this case, the action parameter must be run. The content in parameters is defined by the specific Cloud Function.
• Workflow ID (e.g. F46FF98D7). In this case, the action parameter must be run_sample or run_analyze, and parameters should be empty or ignored.

The get_response parameter is used to indicate whether to synchronously and wait for the response from the command. If set to true, the API will wait for the command to finish and return the response. If set to false, the API will return immediately after the command is started.

The return format is also defined by the specific Cloud Function.

Example:

1. Arivz plot in serverside

// curl -H "Authorization: Bearer $token" "$root/invoke" --json \
{
    "target": "MARVIZPLOT",
    "action": "run",
    "get_response": true,
    "parameters": {
        "experiment_id": "X7CED97DD",
        "return_type": "json",
        "plot_func": "plot_ecdf",
        "plot_chain": "chain#1",
        "plot_var": "σ/val"
    }
}

// OUTPUT
{"status": "ok", "data": {"cloudfunction_response": {<plotdata>}}}

2. Run sample

// curl -H "Authorization: Bearer $token" "$root/invoke" --json \
{
    "target": "F46FF98D7",
    "action": "run_sample",
    "get_response": true
}

// OUTPUT
{"status": "ok", "data": {"experiment_id": "XFF2F7F8B", "experiment_name": "priceless_elion"}}

3. Run Analyze

// curl -H "Authorization: Bearer $token" "$root/invoke" --json \
{
    "target": "F46FF98D7",
    "action": "run_analyze",
    "get_response": false
}

// OUTPUT
{"status": "ok", "data": {}}

POST /invoke

Invoke CloudFunctions

cURL

curl --request POST \
  --url https://api.coinfer.ai/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "<string>",
  "action": "<string>",
  "parameters": {},
  "get_response": false
}
'

200

{
  "status": "<string>",
  "data": "<unknown>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

target · string · required

Target object to perform the action on

action · string · required

Action to perform

parameters · Parameters · object

Parameters for the command

get_response · boolean · default: false

Whether to get the response from the command (Sync run)

Response

200 - application/json

OK

SuccRsp[Any]

ErrRsp

status · string · required

Allowed value: "ok"

data · any · required