Generate Editor Assistant
curl --request POST \
--url https://api.decodahealth.com/ai/editor-assistant/generate \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"message": "<string>",
"currentState": {},
"history": [
{
"content": "<string>",
"timestamp": "<string>",
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
],
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
'import requests
url = "https://api.decodahealth.com/ai/editor-assistant/generate"
payload = {
"message": "<string>",
"currentState": {},
"history": [
{
"content": "<string>",
"timestamp": "<string>",
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
],
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: '<string>',
currentState: {},
history: [
{
content: '<string>',
timestamp: '<string>',
files: [{name: '<string>', size: 123, type: '<string>', data: '<string>'}]
}
],
files: [{name: '<string>', size: 123, type: '<string>', data: '<string>'}]
})
};
fetch('https://api.decodahealth.com/ai/editor-assistant/generate', 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.decodahealth.com/ai/editor-assistant/generate",
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([
'message' => '<string>',
'currentState' => [
],
'history' => [
[
'content' => '<string>',
'timestamp' => '<string>',
'files' => [
[
'name' => '<string>',
'size' => 123,
'type' => '<string>',
'data' => '<string>'
]
]
]
],
'files' => [
[
'name' => '<string>',
'size' => 123,
'type' => '<string>',
'data' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/ai/editor-assistant/generate"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"currentState\": {},\n \"history\": [\n {\n \"content\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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.decodahealth.com/ai/editor-assistant/generate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"currentState\": {},\n \"history\": [\n {\n \"content\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/ai/editor-assistant/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"currentState\": {},\n \"history\": [\n {\n \"content\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Ai
Generate Editor Assistant
Stream AI-generated questions/blocks for the editor assistant.
Streams SSE events:
- type: “message” - AI’s explanation text
- type: “question” - A generated question
- type: “block” - A block header (form mode only)
- type: “form_metadata” - Form name/description update (form mode only)
- type: “template_metadata” - Template name update (template mode only)
- type: “done” - Generation complete
- type: “error” - An error occurred
POST
/
ai
/
editor-assistant
/
generate
Generate Editor Assistant
curl --request POST \
--url https://api.decodahealth.com/ai/editor-assistant/generate \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TENANT: <tenant>' \
--data '
{
"message": "<string>",
"currentState": {},
"history": [
{
"content": "<string>",
"timestamp": "<string>",
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
],
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
'import requests
url = "https://api.decodahealth.com/ai/editor-assistant/generate"
payload = {
"message": "<string>",
"currentState": {},
"history": [
{
"content": "<string>",
"timestamp": "<string>",
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
],
"files": [
{
"name": "<string>",
"size": 123,
"type": "<string>",
"data": "<string>"
}
]
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: '<string>',
currentState: {},
history: [
{
content: '<string>',
timestamp: '<string>',
files: [{name: '<string>', size: 123, type: '<string>', data: '<string>'}]
}
],
files: [{name: '<string>', size: 123, type: '<string>', data: '<string>'}]
})
};
fetch('https://api.decodahealth.com/ai/editor-assistant/generate', 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.decodahealth.com/ai/editor-assistant/generate",
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([
'message' => '<string>',
'currentState' => [
],
'history' => [
[
'content' => '<string>',
'timestamp' => '<string>',
'files' => [
[
'name' => '<string>',
'size' => 123,
'type' => '<string>',
'data' => '<string>'
]
]
]
],
'files' => [
[
'name' => '<string>',
'size' => 123,
'type' => '<string>',
'data' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$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.decodahealth.com/ai/editor-assistant/generate"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"currentState\": {},\n \"history\": [\n {\n \"content\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
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.decodahealth.com/ai/editor-assistant/generate")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"currentState\": {},\n \"history\": [\n {\n \"content\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/ai/editor-assistant/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"currentState\": {},\n \"history\": [\n {\n \"content\": \"<string>\",\n \"timestamp\": \"<string>\",\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"files\": [\n {\n \"name\": \"<string>\",\n \"size\": 123,\n \"type\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Body
application/json
Request schema for the AI editor assistant endpoint.
Editor mode: 'template' for note templates, 'form' for check-in forms
Available options:
template, form User's natural language instruction
Serialized current editor state
Conversation history
Show child attributes
Show child attributes
PDF/image uploads (base64)
Show child attributes
Show child attributes
Response
Successful Response
⌘I
