Get training document details, or request a file upload URL

GET 
/nl2sql/training-documents/:id

This operation has two modes, selected by the action query parameter.

• Without action (the default), returns the full training document record, including UploadedFiles and a one-hour DownloadURL for the first uploaded file when at least one file exists.

• With action=get_upload_url, returns a presigned URL to PUT a training file to. Both document_name and file_name are then required. The file is recorded against the document as soon as the URL is issued, before the upload itself completes, so a URL that is issued but never used leaves a dangling entry in UploadedFiles.

Requires SQLAI to be present in the environment's enabled AI services; otherwise the request fails with AI-1004.

Request

Responses

200

The training document record, or a presigned upload URL when action=get_upload_url.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

400

Input validation or authorization failure. Body is {"Message": " - "}. Codes: AI-1004 (SQLAI is not enabled), IPV-1002 (document id not found), IPV-1001 (document_name or file_name missing while action=get_upload_url), AUTH-1001 / AUTH-1030 (authorization).

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers

500

Backend failure. Codes include GE-1110 (the presigned upload URL could not be generated). Body is {"Message": " - "}.

Response Headers

Access-Control-Allow-Origin
Access-Control-Allow-Methods
Access-Control-Allow-Headers