COconductorone
Report

Save

Changed on

Save copies the program behind an already-rendered reporting surface into a report. The caller identifies the surface; the server resolves which program produced it. There is no create-from-prompt: the prompt has already been answered by the time a report is worth keeping.

post/api/v1/reporting/reports

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/reporting/reports
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

conversationIdstring

The conversation and surface are both required to address a rendered surface; neither identifies one alone.

descriptionstring

Optional user-facing context for a new report. Rejected while applying an edit, where metadata remains unchanged.

displayNamestring

Required for a new report and rejected when report_id is set.

expectedProgramIdstring

Required with report_id. A stale source version is rejected rather than silently overwriting a newer edit.

promptstring

The question this surface answered. Used only when creating a report; applying an edit preserves the report's canonical question and records the incremental instruction on the immutable run.

reportIdstring

Empty creates a report. Set to apply the validated edit surface to an existing report without changing its identity or history.

surfaceIdstring

The surfaceId field.

Response

Successful response

Changes

  • fe943bedf41bRevision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • 918a4e749f56Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      response property report/oneOf[subschema #1: Report]/program/oneOf[subschema #1: Program Ref]/commitId deprecated

    • info

      response property report/oneOf[subschema #1: Report]/program/oneOf[subschema #1: Program Ref]/functionId deprecated