Project Digest
curl --request GET \
--url https://api.ionworks.com/projects/{project_id}/digestimport requests
url = "https://api.ionworks.com/projects/{project_id}/digest"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/projects/{project_id}/digest', 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.ionworks.com/projects/{project_id}/digest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/projects/{project_id}/digest"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/projects/{project_id}/digest")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/projects/{project_id}/digest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"fingerprint": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"text": "<string>",
"instances": {
"count": 0,
"batches": [
"<string>"
],
"measured_properties_keys": [
"<string>"
]
},
"cellSpecifications": {
"count": 0,
"names": [
"<string>"
],
"ratings_keys": [
"<string>"
],
"properties_keys": [
"<string>"
]
},
"measurements": {
"count": 0,
"by_type": {},
"per_instance": {
"min": 0,
"max": 0,
"mean": 0
},
"properties_keys": [
"<string>"
],
"recorded_duration_s": {
"min": 123,
"max": 123
}
},
"analyses": {
"count": 0,
"by_type": {},
"columns_by_type": {}
},
"materials": {
"count": 0,
"names": [
"<string>"
]
},
"materialProperties": {
"count": 0,
"names": [
"<string>"
],
"columns_by_name": {}
},
"simulations": {
"count": 0,
"metrics_keys": [
"<string>"
]
},
"described": {
"measurements_with_steps": 123,
"measurements_with_cycles": 123,
"of": 0
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Project Digest
Everything the project holds, from its records alone: counts, names, JSON keys and analysis columns, plus the same facts rendered as markdown for a prompt.
Project Digest
curl --request GET \
--url https://api.ionworks.com/projects/{project_id}/digestimport requests
url = "https://api.ionworks.com/projects/{project_id}/digest"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/projects/{project_id}/digest', 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.ionworks.com/projects/{project_id}/digest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/projects/{project_id}/digest"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/projects/{project_id}/digest")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/projects/{project_id}/digest")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"fingerprint": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"text": "<string>",
"instances": {
"count": 0,
"batches": [
"<string>"
],
"measured_properties_keys": [
"<string>"
]
},
"cellSpecifications": {
"count": 0,
"names": [
"<string>"
],
"ratings_keys": [
"<string>"
],
"properties_keys": [
"<string>"
]
},
"measurements": {
"count": 0,
"by_type": {},
"per_instance": {
"min": 0,
"max": 0,
"mean": 0
},
"properties_keys": [
"<string>"
],
"recorded_duration_s": {
"min": 123,
"max": 123
}
},
"analyses": {
"count": 0,
"by_type": {},
"columns_by_type": {}
},
"materials": {
"count": 0,
"names": [
"<string>"
]
},
"materialProperties": {
"count": 0,
"names": [
"<string>"
],
"columns_by_name": {}
},
"simulations": {
"count": 0,
"metrics_keys": [
"<string>"
]
},
"described": {
"measurements_with_steps": 123,
"measurements_with_cycles": 123,
"of": 0
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Response
Successful Response
Everything a project holds, in the shape an authoring turn needs up front.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
What the describe cache already knows, so the agent can skip re-reading it.
The counts are null until something has been described in this project.
Show child attributes
Show child attributes
Was this page helpful?