Sign in
public

Generate Report

Start backend report creation from a template ID and note IDs. If the template contains prompt nodes, the backend generates those sections from the supplied notes. If the template contains no prompt nodes, the backend saves the template content directly as a report. The response returns a job_id immediately; poll GET /v1/public/jobs/{job_id} until the job completes.

post/v1/public/clients/{client_id}/reports/generate

Path parameters

client_idinteger required

Request body

template_idstring required
note_idsstring[] required
titlestring nullable

Response

Successful Response

job_idstring required

Changes

Changed in 3 of the 10 revisions of this API.25

  • 7c3f23f9725e14See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ○

      api operation id generate_report_v1_external_clients__client_id__reports_generate_post removed and replaced with generate_report_v1_public_clients__client_id__reports_generate_post

      api-operation-id-removed

    • ○

      api tag public added

      api-tag-added

    • ○

      api tag external removed

      api-tag-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 5af820fa3cab1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 9695d93a926b1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog