Skip to main content
POST
/
rpc
/
public
/
run
Run a public RPC action
curl --request POST \
  --url https://api.sippet.ai/rpc/public/run \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "action": "<string>",
  "input": {},
  "identity": {},
  "fields": [
    "<string>"
  ],
  "filter": {},
  "sort": "<string>",
  "page": {},
  "metadataFields": [
    "<string>"
  ]
}
'
import requests

url = "https://api.sippet.ai/rpc/public/run"

payload = {
"action": "<string>",
"input": {},
"identity": {},
"fields": ["<string>"],
"filter": {},
"sort": "<string>",
"page": {},
"metadataFields": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
action: '<string>',
input: {},
identity: {},
fields: ['<string>'],
filter: {},
sort: '<string>',
page: {},
metadataFields: ['<string>']
})
};

fetch('https://api.sippet.ai/rpc/public/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sippet.ai/rpc/public/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'action' => '<string>',
'input' => [

],
'identity' => [

],
'fields' => [
'<string>'
],
'filter' => [

],
'sort' => '<string>',
'page' => [

],
'metadataFields' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.sippet.ai/rpc/public/run"

payload := strings.NewReader("{\n \"action\": \"<string>\",\n \"input\": {},\n \"identity\": {},\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {},\n \"sort\": \"<string>\",\n \"page\": {},\n \"metadataFields\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.sippet.ai/rpc/public/run")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"<string>\",\n \"input\": {},\n \"identity\": {},\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {},\n \"sort\": \"<string>\",\n \"page\": {},\n \"metadataFields\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sippet.ai/rpc/public/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"<string>\",\n \"input\": {},\n \"identity\": {},\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {},\n \"sort\": \"<string>\",\n \"page\": {},\n \"metadataFields\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {}
}

Authorizations

x-api-key
string
header
required

Use a secret org API key. Do not expose this key in browser code.

Body

application/json
action
string
required

Public RPC action name, for example list_contacts or create_call.

input
object

Action-specific input object.

identity
object

Identity payload for actions that target a specific resource.

fields
(string | object)[]

Field names or nested field-selection objects, depending on the action.

filter
object
sort

Action-specific sort expression.

page
object

Pagination options for list actions.

metadataFields
string[]

Response

200 - application/json

Action executed successfully or returned a structured RPC error.

success
boolean
required
data
required

Action-specific success payload.