Register a reporter
curl --request POST \
--url https://softmax.com/api/observatory/v2/reporters/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"outputs": [
{
"name": "<string>",
"description": "<string>",
"schema": "<string>",
"optional": false
}
]
}
'import requests
url = "https://softmax.com/api/observatory/v2/reporters/register"
payload = {
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"outputs": [
{
"name": "<string>",
"description": "<string>",
"schema": "<string>",
"optional": False
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
display_name: '<string>',
description: '<string>',
outputs: [
{name: '<string>', description: '<string>', schema: '<string>', optional: false}
]
})
};
fetch('https://softmax.com/api/observatory/v2/reporters/register', 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://softmax.com/api/observatory/v2/reporters/register",
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([
'name' => '<string>',
'display_name' => '<string>',
'description' => '<string>',
'outputs' => [
[
'name' => '<string>',
'description' => '<string>',
'schema' => '<string>',
'optional' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://softmax.com/api/observatory/v2/reporters/register"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"outputs\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": \"<string>\",\n \"optional\": false\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://softmax.com/api/observatory/v2/reporters/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"outputs\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": \"<string>\",\n \"optional\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://softmax.com/api/observatory/v2/reporters/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"outputs\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": \"<string>\",\n \"optional\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"user_id": "<string>",
"created": true,
"reporter_key": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Reporters
Register a reporter
Creates a reporter or updates metadata for an existing owner-scoped name. New reporters return a submission key once. Hosted reporters keep the latest version’s output contract.
POST
/
v2
/
reporters
/
register
Register a reporter
curl --request POST \
--url https://softmax.com/api/observatory/v2/reporters/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"outputs": [
{
"name": "<string>",
"description": "<string>",
"schema": "<string>",
"optional": false
}
]
}
'import requests
url = "https://softmax.com/api/observatory/v2/reporters/register"
payload = {
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"outputs": [
{
"name": "<string>",
"description": "<string>",
"schema": "<string>",
"optional": False
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
display_name: '<string>',
description: '<string>',
outputs: [
{name: '<string>', description: '<string>', schema: '<string>', optional: false}
]
})
};
fetch('https://softmax.com/api/observatory/v2/reporters/register', 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://softmax.com/api/observatory/v2/reporters/register",
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([
'name' => '<string>',
'display_name' => '<string>',
'description' => '<string>',
'outputs' => [
[
'name' => '<string>',
'description' => '<string>',
'schema' => '<string>',
'optional' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://softmax.com/api/observatory/v2/reporters/register"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"outputs\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": \"<string>\",\n \"optional\": false\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://softmax.com/api/observatory/v2/reporters/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"outputs\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": \"<string>\",\n \"optional\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://softmax.com/api/observatory/v2/reporters/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"description\": \"<string>\",\n \"outputs\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"schema\": \"<string>\",\n \"optional\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"user_id": "<string>",
"created": true,
"reporter_key": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer token issued by Softmax
Body
application/json
Reporter identity and output contract.
Owner-scoped name used in the reporter handle.
Required string length:
1 - 200Pattern:
^[a-z0-9][a-z0-9_.-]*$Human-readable reporter name.
Required string length:
1 - 200Explanation of what the reporter does.
Required string length:
1 - 2000Output parts the reporter may submit.
Required array length:
1 - 50 elementsShow child attributes
Show child attributes
Response
Successful Response
Reporter ID.
Owner-scoped reporter name.
User who owns the reporter.
Whether this request created the reporter.
Submission key returned once for a new reporter. Updates return null.
Time the reporter was created.