Upload an image (single request)

curl --request POST \
  --url https://api.halfpagetechnologies.com/backend/api/v1/upload \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.halfpagetechnologies.com/backend/api/v1/upload"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.halfpagetechnologies.com/backend/api/v1/upload', 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.halfpagetechnologies.com/backend/api/v1/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.halfpagetechnologies.com/backend/api/v1/upload"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.halfpagetechnologies.com/backend/api/v1/upload")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "image": {
    "id": "<string>",
    "name": "<string>",
    "image_type": "TIFF",
    "size": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "shape": [
      123
    ],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "processed_at": "2023-11-07T05:31:56Z",
    "upload_error": "<string>"
  },
  "success": true
}

{
  "detail": "Requires authentication"
}

{
  "detail": "You've reached your storage limit of 100 images. Upgrade to store more."
}

upload

Upload an image (single request)

Upload a microscopy image in a single request (multipart/form-data with a file field) — the simplest way to get an image into HalfPage.

No prior setup is needed: the image record is created automatically, named after the uploaded file. (To attach the pixels to a record you already created with POST /image, pass its id in the Image-Id header; a row outside your organization returns 404.)

The file is streamed to storage and converted before the response returns, so the returned image is already ready — its id can go straight into POST /job/prediction. For files larger than a few hundred MB or unreliable connections, prefer the resumable flow (POST /image with resumable: true, then PUT the parts and call /upload/{image_id}/complete).

POST

api

upload

Upload an image (single request)

curl --request POST \
  --url https://api.halfpagetechnologies.com/backend/api/v1/upload \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.halfpagetechnologies.com/backend/api/v1/upload"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.halfpagetechnologies.com/backend/api/v1/upload', 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.halfpagetechnologies.com/backend/api/v1/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.halfpagetechnologies.com/backend/api/v1/upload"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.halfpagetechnologies.com/backend/api/v1/upload")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "image": {
    "id": "<string>",
    "name": "<string>",
    "image_type": "TIFF",
    "size": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "shape": [
      123
    ],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "processed_at": "2023-11-07T05:31:56Z",
    "upload_error": "<string>"
  },
  "success": true
}

{
  "detail": "Requires authentication"
}

{
  "detail": "You've reached your storage limit of 100 images. Upgrade to store more."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Image-Id

string | null

Optional id of a pre-created image row to attach this file to. Omit it to have the record created automatically from the uploaded file.

Response

Successful Response

Result of a single-request upload: the image record the pixels landed on. Conversion happens in-request, so image.upload_status is already ready — no polling needed before running a prediction.

image

ImageStatusResponse · object

required

An image's upload lifecycle and metadata — enough to know when a freshly uploaded image is ready to run a prediction against.

Show child attributes

Example:

{
  "created_at": "2026-07-01T12:00:00Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "image_type": "TIFF",
  "name": "sample.tif",
  "processed_at": "2026-07-01T12:00:05Z",
  "shape": [512, 512, 3],
  "size": 4194304,
  "upload_status": "ready"
}

success

boolean

default:true

upload

job

image

segmentation

export

models

Upload an image (single request)

Authorizations

Headers

Response