cURL
curl --request POST \
--url 'https://api.edgeful.com/v1/custom-reports/drafts/<conversation_id>/runs' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}'import requests
url = "https://api.edgeful.com/v1/custom-reports/drafts/<conversation_id>/runs"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'message_id': 'a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60', 'controls': {'ticker': 'NQ', 'start_date': '2025-10-01', 'end_date': '2026-09-30'}}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/custom-reports/drafts/<conversation_id>/runs";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}),
};
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/<conversation_id>/runs");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}');
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/<conversation_id>/runs", strings.NewReader(`{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}`))
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/<conversation_id>/runs"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"message_id\": \"a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60\", \"controls\": {\"ticker\": \"NQ\", \"start_date\": \"2025-10-01\", \"end_date\": \"2026-09-30\"}}"))
.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/<conversation_id>/runs")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"summary": "<unknown>",
"detailed_data": [
"<unknown>"
],
"total_rows": 123,
"truncated": true,
"column_units": "<unknown>",
"row_label": "<unknown>",
"row_grain": "<unknown>",
"presentation": "<unknown>",
"conversation_id": "<string>",
"message_id": "<string>",
"message": "<string>",
"effective_controls": "<unknown>",
"data_through": "<string>",
"url": "<string>"
}custom reports
run custom report draft
run a draft’s frozen code before saving it, on its own inputs or another ticker, session or date range; market and granularity stay locked. no AI credits; uses your run allowance and a run slot. returns the result with every row and stores nothing: the draft is not saved and the run cannot be read again. stopped after three 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.
POST
/
v1
/
custom-reports
/
drafts
/
{conversation_id}
/
runs
cURL
curl --request POST \
--url 'https://api.edgeful.com/v1/custom-reports/drafts/<conversation_id>/runs' \
--header 'Authorization: Bearer <api-key>' \
--header 'Content-Type: application/json' \
--data '{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}'import requests
url = "https://api.edgeful.com/v1/custom-reports/drafts/<conversation_id>/runs"
headers = {"Authorization": "Bearer <api-key>"}
payload = {'message_id': 'a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60', 'controls': {'ticker': 'NQ', 'start_date': '2025-10-01', 'end_date': '2026-09-30'}}
response = requests.post(url, headers=headers, json=payload)
print(response.json())const url = "https://api.edgeful.com/v1/custom-reports/drafts/<conversation_id>/runs";
const options = {
method: "POST",
headers: { Authorization: "Bearer <api-key>", "Content-Type": "application/json" },
body: JSON.stringify({"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}),
};
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/<conversation_id>/runs");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <api-key>", "Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}');
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/<conversation_id>/runs", strings.NewReader(`{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}`))
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/<conversation_id>/runs"))
.header("Authorization", "Bearer <api-key>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"message_id\": \"a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60\", \"controls\": {\"ticker\": \"NQ\", \"start_date\": \"2025-10-01\", \"end_date\": \"2026-09-30\"}}"))
.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/<conversation_id>/runs")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <api-key>"
request["Content-Type"] = "application/json"
request.body = '{"message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "controls": {"ticker": "NQ", "start_date": "2025-10-01", "end_date": "2026-09-30"}}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.body{
"status": "<string>",
"summary": "<unknown>",
"detailed_data": [
"<unknown>"
],
"total_rows": 123,
"truncated": true,
"column_units": "<unknown>",
"row_label": "<unknown>",
"row_grain": "<unknown>",
"presentation": "<unknown>",
"conversation_id": "<string>",
"message_id": "<string>",
"message": "<string>",
"effective_controls": "<unknown>",
"data_through": "<string>",
"url": "<string>"
}Authorizations
Path Parameters
Body
application/json
Response
Successful Response
Was this page helpful?