curl --request POST \
--url 'https://api.edgeful.com/v1/custom-reports/drafts' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}'import requests
url = "https://api.edgeful.com/v1/custom-reports/drafts"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'brief': 'In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.', 'ticker': 'ES', 'market_type': 'futures'}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/custom-reports/drafts";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}),
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/custom-reports/drafts");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/custom-reports/drafts", strings.NewReader(`{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}`))
req.Header.Set("Authorization", "Bearer <api-key>")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.edgeful.com/v1/custom-reports/drafts"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"brief\": \"In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.\", \"ticker\": \"ES\", \"market_type\": \"futures\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/custom-reports/drafts")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"conversation_id": "<string>",
"message_id": "<string>",
"url": "<string>",
"question": "<string>",
"message": "<string>",
"methodology": "<unknown>",
"assumptions": "<unknown>",
"accepted_controls": "<unknown>",
"sample_result": {
"summary": "<unknown>",
"detailed_data": [
"<unknown>"
],
"total_rows": 123,
"truncated": true,
"column_units": "<unknown>",
"row_label": "<unknown>",
"row_grain": "<unknown>",
"presentation": "<unknown>"
},
"truncated": true
}build custom report
build a custom report draft from a plain-language brief. Edgeful generates and validates the code; never send code. uses your Edgeful AI allowance and can take a few minutes. status needs_clarification carries a question: answer it with revise custom report and the returned conversation_id. status succeeded carries the methodology, assumptions, accepted inputs and a sample with every row: review them, then save the draft with save custom report and the returned message_id. stopped after ten minutes. the response stays open until the work finishes or is stopped at its time limit: allow a read timeout of ten minutes, and do not send the request again while it runs. disconnecting cancels the work. a failure after the first ten seconds arrives as 200 with status failed. requires the key’s write permission.
curl --request POST \
--url 'https://api.edgeful.com/v1/custom-reports/drafts' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}'import requests
url = "https://api.edgeful.com/v1/custom-reports/drafts"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'brief': 'In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.', 'ticker': 'ES', 'market_type': 'futures'}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/custom-reports/drafts";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}),
};
const response = await fetch(url, options);
const data = await response.json();
console.log(data);<?php
$ch = curl_init("https://api.edgeful.com/v1/custom-reports/drafts");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/custom-reports/drafts", strings.NewReader(`{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}`))
req.Header.Set("Authorization", "Bearer <api-key>")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.edgeful.com/v1/custom-reports/drafts"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"brief\": \"In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.\", \"ticker\": \"ES\", \"market_type\": \"futures\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());require "net/http"
require "uri"
uri = URI("https://api.edgeful.com/v1/custom-reports/drafts")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"brief": "In the New York session, measure how often the first 30-minute range breaks upward or downward and whether the session closes beyond that range.", "ticker": "ES", "market_type": "futures"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"conversation_id": "<string>",
"message_id": "<string>",
"url": "<string>",
"question": "<string>",
"message": "<string>",
"methodology": "<unknown>",
"assumptions": "<unknown>",
"accepted_controls": "<unknown>",
"sample_result": {
"summary": "<unknown>",
"detailed_data": [
"<unknown>"
],
"total_rows": 123,
"truncated": true,
"column_units": "<unknown>",
"row_label": "<unknown>",
"row_grain": "<unknown>",
"presentation": "<unknown>"
},
"truncated": true
}Authorizations
Body
Response
Successful Response
Was this page helpful?