Notes

Enhance or revise a note

Starts an enhancement using the caller’s existing note-edit authorization. Supply non-empty instructions, an explicit note_template_id, or both. With an explicit template, regenerate that template’s enhanced-note entry from the persisted raw user notes and transcript, applying any supplied instructions. Without a template, revise the persisted HTML of enhanced_note_id, or the entry matching last_note_template_id when the target is omitted. Preserve that entry’s template association. A missing or empty enhanced target is a 400 error; instruction-only requests never fall back to raw notes.

operation_id makes retries idempotent within this note. Reusing an ID with different input is a 409 error. A replay returns the existing operation, including its durable result when completed. A different operation while one is running returns 409. expected_revision, when supplied, must match the note’s current revision. Otherwise the current revision is captured. The final write must still match that captured revision; a concurrent edit fails the operation with an error whose code is 409 and leaves that edit intact.

The operation continues if the client disconnects. A 200 response contains its terminal snapshot; a 202 response contains a still-running snapshot. Attach to GET on this endpoint to observe progress or recover after reconnect.

POST

{team_id}

notes

{note_id}

enhancement

Enhance or revise a note

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": "<string>",
  "note_template_id": "<string>",
  "enhanced_note_id": "<string>",
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_revision": 1
}
'

import requests

url = "https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement"

payload = {
    "instructions": "<string>",
    "note_template_id": "<string>",
    "enhanced_note_id": "<string>",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_revision": 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({
    instructions: '<string>',
    note_template_id: '<string>',
    enhanced_note_id: '<string>',
    operation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_revision: 1
  })
};

fetch('https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement', 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.superthread.com/v1/{team_id}/notes/{note_id}/enhancement",
  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([
    'instructions' => '<string>',
    'note_template_id' => '<string>',
    'enhanced_note_id' => '<string>',
    'operation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'expected_revision' => 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.superthread.com/v1/{team_id}/notes/{note_id}/enhancement"

	payload := strings.NewReader("{\n  \"instructions\": \"<string>\",\n  \"note_template_id\": \"<string>\",\n  \"enhanced_note_id\": \"<string>\",\n  \"operation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_revision\": 1\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.superthread.com/v1/{team_id}/notes/{note_id}/enhancement")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": \"<string>\",\n  \"note_template_id\": \"<string>\",\n  \"enhanced_note_id\": \"<string>\",\n  \"operation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_revision\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement")

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  \"instructions\": \"<string>\",\n  \"note_template_id\": \"<string>\",\n  \"enhanced_note_id\": \"<string>\",\n  \"operation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_revision\": 1\n}"

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

{
  "enhancement": {
    "note_id": "<string>",
    "base_revision": 1,
    "sequence": 1,
    "status": "idle",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "note_template_id": "<string>",
    "enhanced_note_id": "<string>",
    "mode": "revise",
    "content": "<string>",
    "ai_note": {
      "id": "866a3b86-4651-482c-bb69-61921ea4548c",
      "note_template_id": "1da3b68c-3a82-495c-a6c9-e7a494281a36",
      "title": "Team Note",
      "content": "<string>",
      "time_updated": 1608742037016,
      "related_resources": [
        {
          "id": "123",
          "type": "card",
          "cosine_similarity": 0.8
        }
      ]
    },
    "error": {
      "id": "err5f744ab",
      "code": 403,
      "sec": "SEC:000-00014",
      "message": "You do not have access to this resource",
      "date": 1608742037016
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016
  }
}

{
  "enhancement": {
    "note_id": "<string>",
    "base_revision": 1,
    "sequence": 1,
    "status": "idle",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "note_template_id": "<string>",
    "enhanced_note_id": "<string>",
    "mode": "revise",
    "content": "<string>",
    "ai_note": {
      "id": "866a3b86-4651-482c-bb69-61921ea4548c",
      "note_template_id": "1da3b68c-3a82-495c-a6c9-e7a494281a36",
      "title": "Team Note",
      "content": "<string>",
      "time_updated": 1608742037016,
      "related_resources": [
        {
          "id": "123",
          "type": "card",
          "cosine_similarity": 0.8
        }
      ]
    },
    "error": {
      "id": "err5f744ab",
      "code": 403,
      "sec": "SEC:000-00014",
      "message": "You do not have access to this resource",
      "date": 1608742037016
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

Only the note owner can use this endpoint. Custom-agent note read grants do not allow enhancement. Provide instructions to revise existing saved enhanced HTML, note_template_id to regenerate from raw user notes and transcript, or both. Read the note first and supply its revision as expected_revision. Raw notes, transcript, and the template remain unchanged. A 200 response contains a terminal snapshot; 202 means the operation is still running. Only enhancement.status: completed with enhancement.ai_note confirms a saved result. Failed previews are not saved. Use GET enhancement to observe progress, including after disconnecting. An optional UUID operation_id makes identical retries idempotent. Reusing it with different inputs or starting another operation while one runs returns 409. A concurrent note edit prevents the final save and produces a failed operation with error code 409; read the note again before retrying. See CLI flags and MCP operations.

Authorizations

Authorization

string

header

required

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

Path Parameters

team_id

string

required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

note_id

string

required

Note ID is a numerical string that identifies a Note.

Body

application/json

Instructions or an explicit template, with optional retry and concurrency guards.

At least one of non-empty instructions or an explicit note_template_id is required. Existing template-only clients may continue using ApplyNoteTemplateRequest unchanged.

instructions

string

Instructions to revise current enhanced HTML, or to apply while regenerating with an explicit template.

Maximum string length: 102400

note_template_id

string

Explicit template to regenerate from raw user notes and transcript. Omit to revise current enhanced HTML.

enhanced_note_id

string

Target for an instruction-only revision. Omit to use the entry matching the note's last_note_template_id. An explicit template selects its own entry.

operation_id

string<uuid>

Optional client-generated UUID for idempotent retries. The server generates an ID when omitted.

expected_revision

integer<int64> | null

Revision from the latest GetNote response. A stale value is rejected with 409; omission captures the current note revision.

Required range: x >= 0

Response

Terminal enhancement snapshot; completed results have been durably saved.

enhancement

object

required

Show child attributes

⌘I

Enhance or revise a note

curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instructions": "<string>",
  "note_template_id": "<string>",
  "enhanced_note_id": "<string>",
  "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expected_revision": 1
}
'

import requests

url = "https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement"

payload = {
    "instructions": "<string>",
    "note_template_id": "<string>",
    "enhanced_note_id": "<string>",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expected_revision": 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({
    instructions: '<string>',
    note_template_id: '<string>',
    enhanced_note_id: '<string>',
    operation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expected_revision: 1
  })
};

fetch('https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement', 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.superthread.com/v1/{team_id}/notes/{note_id}/enhancement",
  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([
    'instructions' => '<string>',
    'note_template_id' => '<string>',
    'enhanced_note_id' => '<string>',
    'operation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'expected_revision' => 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.superthread.com/v1/{team_id}/notes/{note_id}/enhancement"

	payload := strings.NewReader("{\n  \"instructions\": \"<string>\",\n  \"note_template_id\": \"<string>\",\n  \"enhanced_note_id\": \"<string>\",\n  \"operation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_revision\": 1\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.superthread.com/v1/{team_id}/notes/{note_id}/enhancement")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": \"<string>\",\n  \"note_template_id\": \"<string>\",\n  \"enhanced_note_id\": \"<string>\",\n  \"operation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_revision\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superthread.com/v1/{team_id}/notes/{note_id}/enhancement")

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  \"instructions\": \"<string>\",\n  \"note_template_id\": \"<string>\",\n  \"enhanced_note_id\": \"<string>\",\n  \"operation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"expected_revision\": 1\n}"

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

{
  "enhancement": {
    "note_id": "<string>",
    "base_revision": 1,
    "sequence": 1,
    "status": "idle",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "note_template_id": "<string>",
    "enhanced_note_id": "<string>",
    "mode": "revise",
    "content": "<string>",
    "ai_note": {
      "id": "866a3b86-4651-482c-bb69-61921ea4548c",
      "note_template_id": "1da3b68c-3a82-495c-a6c9-e7a494281a36",
      "title": "Team Note",
      "content": "<string>",
      "time_updated": 1608742037016,
      "related_resources": [
        {
          "id": "123",
          "type": "card",
          "cosine_similarity": 0.8
        }
      ]
    },
    "error": {
      "id": "err5f744ab",
      "code": 403,
      "sec": "SEC:000-00014",
      "message": "You do not have access to this resource",
      "date": 1608742037016
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016
  }
}

{
  "enhancement": {
    "note_id": "<string>",
    "base_revision": 1,
    "sequence": 1,
    "status": "idle",
    "operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "note_template_id": "<string>",
    "enhanced_note_id": "<string>",
    "mode": "revise",
    "content": "<string>",
    "ai_note": {
      "id": "866a3b86-4651-482c-bb69-61921ea4548c",
      "note_template_id": "1da3b68c-3a82-495c-a6c9-e7a494281a36",
      "title": "Team Note",
      "content": "<string>",
      "time_updated": 1608742037016,
      "related_resources": [
        {
          "id": "123",
          "type": "card",
          "cosine_similarity": 0.8
        }
      ]
    },
    "error": {
      "id": "err5f744ab",
      "code": 403,
      "sec": "SEC:000-00014",
      "message": "You do not have access to this resource",
      "date": 1608742037016
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

Get started

Users

Cards

Projects

Notes

Pages

Comments

Boards

Sprints

Spaces

Saved filters

Time tracking

Search

Enhance or revise a note

Authorizations

Path Parameters

Body

Response