Request a format-driven result export
import requests
url = "https://app.strandai.com/api/v1/jobs/{id}/exports"
payload = {
"includeHe": False,
"includeSegmentation": False,
"includeOriginalUpload": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://app.strandai.com/api/v1/jobs/{id}/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"includeHe": false,
"includeSegmentation": false,
"includeOriginalUpload": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({includeHe: false, includeSegmentation: false, includeOriginalUpload: false})
};
fetch('https://app.strandai.com/api/v1/jobs/{id}/exports', 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://app.strandai.com/api/v1/jobs/{id}/exports",
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([
'includeHe' => false,
'includeSegmentation' => false,
'includeOriginalUpload' => 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://app.strandai.com/api/v1/jobs/{id}/exports"
payload := strings.NewReader("{\n \"includeHe\": false,\n \"includeSegmentation\": false,\n \"includeOriginalUpload\": false\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://app.strandai.com/api/v1/jobs/{id}/exports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"includeHe\": false,\n \"includeSegmentation\": false,\n \"includeOriginalUpload\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.strandai.com/api/v1/jobs/{id}/exports")
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 \"includeHe\": false,\n \"includeSegmentation\": false,\n \"includeOriginalUpload\": false\n}"
response = http.request(request)
puts response.read_body{
"schemaVersion": "1.0",
"status": "pending",
"format": "ome-zarr",
"selection": {
"includeHe": true,
"includeSegmentation": true,
"includeOriginalUpload": true
},
"expiresAt": "2023-11-07T05:31:56Z",
"retryable": true,
"error": "<string>",
"artifacts": {
"prediction": {
"format": "ome-zarr-v3",
"role": "predicted-mif",
"dataModel": "pixel-grid",
"stored": true,
"converted": true,
"includesHe": true,
"rootUrl": "<string>",
"baseUrl": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 123
},
"he": {
"format": "ome-zarr-v3",
"role": "processed-registered-he",
"rootUrl": "<string>",
"baseUrl": "<string>"
},
"segmentation": {
"schemaVersion": "1.0",
"layerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityType": "<string>",
"modelVersion": "<string>",
"coordinateFrame": "<string>",
"instanceCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"artifacts": {
"mask": {
"format": "ome-zarr-v3",
"dtype": "uint32",
"baseUrl": "<string>"
},
"cells": {
"format": "parquet",
"morphologyUrl": "<string>",
"markerExpressionBaseUrl": "<string>",
"markers": [
"<string>"
],
"joinKey": "instance_id",
"maskJoinKey": "local_label",
"geometry": [
"<string>"
],
"morphology": [
"<string>"
],
"expression": [
"<string>"
]
},
"provenance": {
"format": "json",
"url": "<string>"
}
},
"downloads": {
"expiresAt": "2023-11-07T05:31:56Z",
"provenance": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"morphology": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"markers": [
{
"marker": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
}
]
}
},
"originalUpload": {
"status": "ready",
"role": "original-upload",
"filename": "<string>",
"contentType": "<string>",
"sizeBytes": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"storedCopy": "uploaded",
"warning": "<string>"
}
}
}{
"schemaVersion": "1.0",
"status": "pending",
"format": "ome-zarr",
"selection": {
"includeHe": true,
"includeSegmentation": true,
"includeOriginalUpload": true
},
"expiresAt": "2023-11-07T05:31:56Z",
"retryable": true,
"error": "<string>",
"artifacts": {
"prediction": {
"format": "ome-zarr-v3",
"role": "predicted-mif",
"dataModel": "pixel-grid",
"stored": true,
"converted": true,
"includesHe": true,
"rootUrl": "<string>",
"baseUrl": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 123
},
"he": {
"format": "ome-zarr-v3",
"role": "processed-registered-he",
"rootUrl": "<string>",
"baseUrl": "<string>"
},
"segmentation": {
"schemaVersion": "1.0",
"layerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityType": "<string>",
"modelVersion": "<string>",
"coordinateFrame": "<string>",
"instanceCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"artifacts": {
"mask": {
"format": "ome-zarr-v3",
"dtype": "uint32",
"baseUrl": "<string>"
},
"cells": {
"format": "parquet",
"morphologyUrl": "<string>",
"markerExpressionBaseUrl": "<string>",
"markers": [
"<string>"
],
"joinKey": "instance_id",
"maskJoinKey": "local_label",
"geometry": [
"<string>"
],
"morphology": [
"<string>"
],
"expression": [
"<string>"
]
},
"provenance": {
"format": "json",
"url": "<string>"
}
},
"downloads": {
"expiresAt": "2023-11-07T05:31:56Z",
"provenance": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"morphology": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"markers": [
{
"marker": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
}
]
}
},
"originalUpload": {
"status": "ready",
"role": "original-upload",
"filename": "<string>",
"contentType": "<string>",
"sizeBytes": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"storedCopy": "uploaded",
"warning": "<string>"
}
}
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}Endpoints
Request result export
Select native OME-Zarr, OME-Zarr ZIP, or OME-TIFF and optional H&E/segmentation contents.
POST
/
jobs
/
{id}
/
exports
Request a format-driven result export
import requests
url = "https://app.strandai.com/api/v1/jobs/{id}/exports"
payload = {
"includeHe": False,
"includeSegmentation": False,
"includeOriginalUpload": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://app.strandai.com/api/v1/jobs/{id}/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"includeHe": false,
"includeSegmentation": false,
"includeOriginalUpload": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({includeHe: false, includeSegmentation: false, includeOriginalUpload: false})
};
fetch('https://app.strandai.com/api/v1/jobs/{id}/exports', 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://app.strandai.com/api/v1/jobs/{id}/exports",
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([
'includeHe' => false,
'includeSegmentation' => false,
'includeOriginalUpload' => 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://app.strandai.com/api/v1/jobs/{id}/exports"
payload := strings.NewReader("{\n \"includeHe\": false,\n \"includeSegmentation\": false,\n \"includeOriginalUpload\": false\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://app.strandai.com/api/v1/jobs/{id}/exports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"includeHe\": false,\n \"includeSegmentation\": false,\n \"includeOriginalUpload\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.strandai.com/api/v1/jobs/{id}/exports")
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 \"includeHe\": false,\n \"includeSegmentation\": false,\n \"includeOriginalUpload\": false\n}"
response = http.request(request)
puts response.read_body{
"schemaVersion": "1.0",
"status": "pending",
"format": "ome-zarr",
"selection": {
"includeHe": true,
"includeSegmentation": true,
"includeOriginalUpload": true
},
"expiresAt": "2023-11-07T05:31:56Z",
"retryable": true,
"error": "<string>",
"artifacts": {
"prediction": {
"format": "ome-zarr-v3",
"role": "predicted-mif",
"dataModel": "pixel-grid",
"stored": true,
"converted": true,
"includesHe": true,
"rootUrl": "<string>",
"baseUrl": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 123
},
"he": {
"format": "ome-zarr-v3",
"role": "processed-registered-he",
"rootUrl": "<string>",
"baseUrl": "<string>"
},
"segmentation": {
"schemaVersion": "1.0",
"layerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityType": "<string>",
"modelVersion": "<string>",
"coordinateFrame": "<string>",
"instanceCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"artifacts": {
"mask": {
"format": "ome-zarr-v3",
"dtype": "uint32",
"baseUrl": "<string>"
},
"cells": {
"format": "parquet",
"morphologyUrl": "<string>",
"markerExpressionBaseUrl": "<string>",
"markers": [
"<string>"
],
"joinKey": "instance_id",
"maskJoinKey": "local_label",
"geometry": [
"<string>"
],
"morphology": [
"<string>"
],
"expression": [
"<string>"
]
},
"provenance": {
"format": "json",
"url": "<string>"
}
},
"downloads": {
"expiresAt": "2023-11-07T05:31:56Z",
"provenance": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"morphology": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"markers": [
{
"marker": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
}
]
}
},
"originalUpload": {
"status": "ready",
"role": "original-upload",
"filename": "<string>",
"contentType": "<string>",
"sizeBytes": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"storedCopy": "uploaded",
"warning": "<string>"
}
}
}{
"schemaVersion": "1.0",
"status": "pending",
"format": "ome-zarr",
"selection": {
"includeHe": true,
"includeSegmentation": true,
"includeOriginalUpload": true
},
"expiresAt": "2023-11-07T05:31:56Z",
"retryable": true,
"error": "<string>",
"artifacts": {
"prediction": {
"format": "ome-zarr-v3",
"role": "predicted-mif",
"dataModel": "pixel-grid",
"stored": true,
"converted": true,
"includesHe": true,
"rootUrl": "<string>",
"baseUrl": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 123
},
"he": {
"format": "ome-zarr-v3",
"role": "processed-registered-he",
"rootUrl": "<string>",
"baseUrl": "<string>"
},
"segmentation": {
"schemaVersion": "1.0",
"layerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityType": "<string>",
"modelVersion": "<string>",
"coordinateFrame": "<string>",
"instanceCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"artifacts": {
"mask": {
"format": "ome-zarr-v3",
"dtype": "uint32",
"baseUrl": "<string>"
},
"cells": {
"format": "parquet",
"morphologyUrl": "<string>",
"markerExpressionBaseUrl": "<string>",
"markers": [
"<string>"
],
"joinKey": "instance_id",
"maskJoinKey": "local_label",
"geometry": [
"<string>"
],
"morphology": [
"<string>"
],
"expression": [
"<string>"
]
},
"provenance": {
"format": "json",
"url": "<string>"
}
},
"downloads": {
"expiresAt": "2023-11-07T05:31:56Z",
"provenance": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"morphology": {
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
},
"markers": [
{
"marker": "<string>",
"downloadUrl": "<string>",
"sizeBytes": 1,
"contentType": "<string>"
}
]
}
},
"originalUpload": {
"status": "ready",
"role": "original-upload",
"filename": "<string>",
"contentType": "<string>",
"sizeBytes": 123,
"expiresAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>",
"storedCopy": "uploaded",
"warning": "<string>"
}
}
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}{
"error": "<string>",
"message": "<string>",
"required": 123,
"retryAfterSeconds": 123
}Native OME-Zarr is returned without conversion. ZIP and TIFF generation is asynchronous and cached; repeating the same request reuses active/ready work or retries a failed export. The response manifest records selected contents, expiration, retryability, and artifact URLs.
Authorizations
ApiKeyOAuth2
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Available options:
ome-zarr, ome-zarr-zip, ome-tiff Include processed/registered H&E.
Include segmentation artifacts. Segmentation jobs always enable this selection. OAuth requests conditionally require samples:read when segmentation artifacts are included.
Request the separate multi-GB source file stored by Strand, not processed/registered H&E. If ingest de-identification ran, this is the stored de-identified copy. OAuth requests conditionally require samples:read when this option is true.
Response
Native or cached result ready
Available options:
1.0 Available options:
pending, running, ready, failed Available options:
ome-zarr, ome-zarr-zip, ome-tiff Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?