Skip to main content

ReportRunCreate

Payload used to create Report Run. The required field is prompt.

name object
anyOf
string
alias object
anyOf
string
report_id object
anyOf
string
collection_id object
anyOf
string

Possible values: non-empty

folder_id object
anyOf
string
tags object
anyOf
  • Array [
    • string
  • ]
    • description object
    anyOf
    string
    requested_formatsstring[]
    promptPrompt (string)required

    Possible values: non-empty

    title object
    anyOf
    string
    template_id object
    anyOf
    string
    assistant_model_id object
    anyOf
    string

    Possible values: non-empty and <= 512 characters

    expected_source_countExpected Source Count (integer)

    Possible values: >= 0 and <= 16

    Default value: 0
    idempotency_key object
    anyOf
    string

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[A-Za-z0-9._:-]+$

    reporter_request_fingerprint object
    anyOf
    string

    Possible values: Value must match regular expression ^[0-9a-f]{64}$

    languageLanguage (string)
    Default value: ko
    options object
    property name*any
    ReportRunCreate
    {
      "name": "string",
      "alias": "string",
      "report_id": "string",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "requested_formats": [
        "string"
      ],
      "prompt": "string",
      "title": "string",
      "template_id": "string",
      "assistant_model_id": "string",
      "expected_source_count": 0,
      "idempotency_key": "string",
      "reporter_request_fingerprint": "string",
      "language": "ko",
      "options": {}
    }