> ## Documentation Index > Fetch the complete documentation index at: https://edgeful.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # save custom report > publish a reviewed, successful builder draft as a saved custom report, labeled built via API, and return its definition_id. the conversation_id and message_id come from a build: building and revising stay in Claude over MCP and in Edgeful AI. this changes your account; requires the key's write permission. ## OpenAPI ````yaml /openapi-public.json post /v1/custom-reports openapi: 3.1.0 info: title: Edgeful API description: >- Public API reference for Edgeful market analysis. The bearer token is your Edgeful API key. Reports support the docs playground. Report responses include row-level output in `detailed` only when your plan includes row-level detail. version: 1.0.0 servers: - url: https://api.edgeful.com description: Production security: - BearerAuth: [] tags: - name: reports - name: discovery - name: live data - name: settings - name: custom reports paths: /v1/custom-reports: post: tags: - custom reports summary: save custom report description: >- publish a reviewed, successful builder draft as a saved custom report, labeled built via API, and return its definition_id. the conversation_id and message_id come from a build: building and revising stay in Claude over MCP and in Edgeful AI. this changes your account; requires the key's write permission. operationId: save_custom_report requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomReportSaveRequest' examples: default: summary: save a reviewed draft value: conversation_id: 5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11 message_id: a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60 name: NQ gap fills by weekday responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomReportSaveResponse' '403': description: >- Valid API key, but the account has no API-enabled subscription or the key's writes are off. content: application/json: examples: missing_entitlement: summary: missing entitlement value: detail: detail: No active subscription with API access found. code: missing_entitlement writes_disabled: summary: writes disabled value: detail: detail: >- Enable writes for this API key or connected Claude in the API dashboard. code: writes_disabled '404': description: the builder conversation or message is not yours, or does not exist. '409': description: the build has not completed yet. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: >- The account's custom report write budget is exhausted; wait `Retry-After` seconds. Refused attempts count too. content: application/json: examples: write_budget_exhausted: summary: write budget exhausted value: detail: detail: Custom report write limit reached. Try again shortly. code: write_budget_exhausted headers: Retry-After: description: seconds to wait before sending the write again. schema: type: integer '503': description: The write budget could not be checked; retry shortly. content: application/json: examples: write_limits_unavailable: summary: write limits unavailable value: detail: detail: >- Custom report write limits are temporarily unavailable. Try again shortly. code: write_limits_unavailable security: - BearerAuth: [] x-codeSamples: - lang: curl label: cURL source: |- curl --request POST \ --url 'https://api.edgeful.com/v1/custom-reports' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{"conversation_id": "5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11", "message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "name": "NQ gap fills by weekday"}' - lang: python label: Python source: >- import requests url = "https://api.edgeful.com/v1/custom-reports" headers = {"Authorization": "Bearer "} payload = {'conversation_id': '5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11', 'message_id': 'a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60', 'name': 'NQ gap fills by weekday'} response = requests.post(url, headers=headers, json=payload) print(response.json()) - lang: javascript label: JavaScript source: |- const url = "https://api.edgeful.com/v1/custom-reports"; const options = { method: "POST", headers: { Authorization: "Bearer ", "Content-Type": "application/json" }, body: JSON.stringify({"conversation_id": "5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11", "message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "name": "NQ gap fills by weekday"}), }; const response = await fetch(url, options); const data = await response.json(); console.log(data); - lang: php label: PHP source: >- ", "Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{"conversation_id": "5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11", "message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "name": "NQ gap fills by weekday"}'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); echo $response; - lang: go label: Go source: |- package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://api.edgeful.com/v1/custom-reports", strings.NewReader(`{"conversation_id": "5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11", "message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "name": "NQ gap fills by weekday"}`)) req.Header.Set("Authorization", "Bearer ") 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)) } - lang: java label: Java source: >- 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")) .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString("{\"conversation_id\": \"5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11\", \"message_id\": \"a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60\", \"name\": \"NQ gap fills by weekday\"}")) .build(); HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); - lang: ruby label: Ruby source: >- require "net/http" require "uri" uri = URI("https://api.edgeful.com/v1/custom-reports") request = Net::HTTP::Post.new(uri) request["Authorization"] = "Bearer " request["Content-Type"] = "application/json" request.body = '{"conversation_id": "5b0c8f7e-2f7a-4f43-9d39-0f6f0c8d2a11", "message_id": "a3e1f2d4-6c5b-4e7a-8f90-1b2c3d4e5f60", "name": "NQ gap fills by weekday"}' response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http| http.request(request) end puts response.body components: schemas: CustomReportSaveRequest: properties: conversation_id: type: string format: uuid title: Conversation Id description: the builder conversation the reviewed draft belongs to. message_id: type: string format: uuid title: Message Id description: the successful builder message to publish. name: type: string maxLength: 80 minLength: 1 title: Name description: the saved report's name. additionalProperties: false type: object required: - conversation_id - message_id - name title: CustomReportSaveRequest CustomReportSaveResponse: properties: definition_id: type: string title: Definition Id description: saved custom report id. name: type: string title: Name description: report name. methodology: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: the methodology the builder recorded. assumptions: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: the assumptions the builder recorded. origin: anyOf: - type: string - type: 'null' title: Origin description: api for a report saved through the API, else app. status: type: string title: Status description: saved. truncated: anyOf: - type: boolean - type: 'null' title: Truncated description: true when a long methodology or assumptions list was shortened. additionalProperties: true type: object required: - definition_id - name - status title: CustomReportSaveResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError JsonValue: {} ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Send your Edgeful API key in the Authorization header as `Bearer ` (for example, `Bearer ef_live_`). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.