Skip to main content
POST
/
api
/
v1
/
attachment_commitments
Finalize prepared rich-text image uploads
curl --request POST \
  --url https://formhug.ai/api/v1/attachment_commitments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "upload_ids": [
    "rich_text_image.ab12cd34ef567890"
  ]
}
'
import requests

url = "https://formhug.ai/api/v1/attachment_commitments"

payload = { "upload_ids": ["rich_text_image.ab12cd34ef567890"] }
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({upload_ids: ['rich_text_image.ab12cd34ef567890']})
};

fetch('https://formhug.ai/api/v1/attachment_commitments', 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://formhug.ai/api/v1/attachment_commitments",
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([
'upload_ids' => [
'rich_text_image.ab12cd34ef567890'
]
]),
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://formhug.ai/api/v1/attachment_commitments"

payload := strings.NewReader("{\n \"upload_ids\": [\n \"rich_text_image.ab12cd34ef567890\"\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://formhug.ai/api/v1/attachment_commitments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"upload_ids\": [\n \"rich_text_image.ab12cd34ef567890\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://formhug.ai/api/v1/attachment_commitments")

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 \"upload_ids\": [\n \"rich_text_image.ab12cd34ef567890\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "attachments": [
      {
        "upload_id": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "file_name": "<string>"
      }
    ]
  }
}
{
"error": "<string>"
}
{
"error": "Invalid upload_ids",
"error_details": [
{
"attribute": "upload_ids[1]",
"message": "upload session not found or expired"
}
]
}

Authorizations

Authorization
string
header
required

Personal Access Token prefixed with fh_. Sent as Authorization: Bearer fh_xxx. The scope required by each endpoint is listed in that endpoint's description.

Body

application/json
upload_ids
string[]
required

upload_ids from POST /api/v1/attachments (purpose rich_text_image), each after its file was PUT to the upload_url. Finalized atomically: any invalid entry rejects the whole request, and already-processed entries are remembered so an identical retry does not duplicate them.

Required array length: 1 - 20 elements
Minimum string length: 1

Response

Images stored

data
object
required

Finalize-step response: the stored rich-text images, in the same order as the request upload_ids. Embed each image_url into your rich-text HTML (e.g. <img src="...">).

Last modified on July 9, 2026