DocDealer
    Sign in
    ReferenceTemplatesTemplateidSummary schema

    Set the draft summary schema

    The summary schema the next published version will carry ({ fields: { key: { type, label?, instructions?, properties?, items? } } }, or null for none).…

    PUT
    /templates/{templateId}/summary-schema

    The summary schema the next published version will carry ({ fields: { key: { type, label?, instructions?, properties?, items? } } }, or null for none). Published versions keep theirs. A top-level key may not change type across versions. Admins only.

    Authorization

    bearerAuth
    AuthorizationBearer <token>

    In: header

    Path Parameters

    templateId*string

    Request Body

    application/json

    TypeScript Definitions

    Use the request body type in TypeScript.

    Response Body

    application/json

    application/json

    application/json

    application/json

    application/json

    curl -X PUT "https://example.com/templates/string/summary-schema" \  -H "Content-Type: application/json" \  -d '{    "summarySchema": {      "property1": null,      "property2": null    }  }'
    {  "summarySchema": {    "property1": null,    "property2": null  }}

    Extract summaries for existing documents POST

    Queues an extraction for documents whose version defines a summary, each with its own version's schema. Default: only documents without a current summary.…

    List template versions GET

    List template versions - GET /templates/{templateId}/versions. DocDealer REST API reference.