Create Report Instance

URL Expired

The URL for this request expired after 30 days.

Fields

• hashid: string (required)
  Serializer for creating a report instance.
• user_prompt: string
  User-provided prompt or instructions for this report instance
• file_records: array of strings
  List of file record IDs to include in the report
• folder_id: string | null
  Folder ID to filter file records (alternative to file_records)
• extraction_result_ids: array of strings
  List of extraction result IDs to filter file records
• content-type: string (enum)
  Defaults to application/json

Allowed Content Types

• application/json
• application/x-www-form-urlencoded
• multipart/form-data

API Responses

202

• object: JSON API formatted serializer for report instances.
  • id: string (required)
  • type: string (required)
  • attributes: object (required)
    • Has additional fields
  • relationships: object (required)
    • Has additional fields

Error Codes

• 400
• 401
• 404

Example Request

curl --request POST \
     --url https://api.flextract.dev/api/v1/reports/hashid/instances/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

{
  "id": "string",
  "type": "string",
  "attributes": {},
  "relationships": {}
}