Predict
curl --request POST \
--url https://api.example.com/v1/models/{model_id}/predict \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dataframe": {
"plan": {},
"columns": [
{
"name": "<string>",
"datatype": {
"kind": "string"
}
}
],
"version": 1
}
}
'import requests
url = "https://api.example.com/v1/models/{model_id}/predict"
payload = { "dataframe": {
"plan": {},
"columns": [
{
"name": "<string>",
"datatype": { "kind": "string" }
}
],
"version": 1
} }
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({
dataframe: {
plan: {},
columns: [{name: '<string>', datatype: {kind: 'string'}}],
version: 1
}
})
};
fetch('https://api.example.com/v1/models/{model_id}/predict', 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.example.com/v1/models/{model_id}/predict",
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([
'dataframe' => [
'plan' => [
],
'columns' => [
[
'name' => '<string>',
'datatype' => [
'kind' => 'string'
]
]
],
'version' => 1
]
]),
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://api.example.com/v1/models/{model_id}/predict"
payload := strings.NewReader("{\n \"dataframe\": {\n \"plan\": {},\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"datatype\": {\n \"kind\": \"string\"\n }\n }\n ],\n \"version\": 1\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://api.example.com/v1/models/{model_id}/predict")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dataframe\": {\n \"plan\": {},\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"datatype\": {\n \"kind\": \"string\"\n }\n }\n ],\n \"version\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/models/{model_id}/predict")
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 \"dataframe\": {\n \"plan\": {},\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"datatype\": {\n \"kind\": \"string\"\n }\n }\n ],\n \"version\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}inference
Predict
Batch predictions from a trained model.
POST
/
v1
/
models
/
{model_id}
/
predict
Predict
curl --request POST \
--url https://api.example.com/v1/models/{model_id}/predict \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dataframe": {
"plan": {},
"columns": [
{
"name": "<string>",
"datatype": {
"kind": "string"
}
}
],
"version": 1
}
}
'import requests
url = "https://api.example.com/v1/models/{model_id}/predict"
payload = { "dataframe": {
"plan": {},
"columns": [
{
"name": "<string>",
"datatype": { "kind": "string" }
}
],
"version": 1
} }
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({
dataframe: {
plan: {},
columns: [{name: '<string>', datatype: {kind: 'string'}}],
version: 1
}
})
};
fetch('https://api.example.com/v1/models/{model_id}/predict', 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.example.com/v1/models/{model_id}/predict",
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([
'dataframe' => [
'plan' => [
],
'columns' => [
[
'name' => '<string>',
'datatype' => [
'kind' => 'string'
]
]
],
'version' => 1
]
]),
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://api.example.com/v1/models/{model_id}/predict"
payload := strings.NewReader("{\n \"dataframe\": {\n \"plan\": {},\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"datatype\": {\n \"kind\": \"string\"\n }\n }\n ],\n \"version\": 1\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://api.example.com/v1/models/{model_id}/predict")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dataframe\": {\n \"plan\": {},\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"datatype\": {\n \"kind\": \"string\"\n }\n }\n ],\n \"version\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/models/{model_id}/predict")
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 \"dataframe\": {\n \"plan\": {},\n \"columns\": [\n {\n \"name\": \"<string>\",\n \"datatype\": {\n \"kind\": \"string\"\n }\n }\n ],\n \"version\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
An API key or OAuth2/OIDC access token sent as Authorization: Bearer <token>.
Path Parameters
Body
application/json
Inline DataFrame plan (connection config + columns + optional filter) describing the rows to score. The server ships the plan + session to the inference worker, which rebuilds the org context and materializes inside its container.
Show child attributes
Show child attributes
⌘I