Document Platform

Analyse PDF document for splitting suggestions using AI

get/customers/{customerId}/buildings/{buildingId}/documents/{documentId}/analyze-split

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/documents/{documentId}/analyze-split
  • Auth: API key in header x-api-key

Path parameters

buildingIdstring uuid required
documentIdstring uuid required

Query parameters

modelstring

OpenAI model to use (e.g., gpt-5-pro, gpt-5, gpt-5-mini)

reasoningEffort'minimal' | 'low' | 'medium' | 'high'

Reasoning effort level (not supported for gpt-5-pro)

verbosity'low' | 'medium' | 'high'

Verbosity level for response text

Response

Default Response

documentIdstring
totalPagesnumber
summarystring
recommendSplitboolean
reasoningstring
metadataobject

Changes

No recorded changes to this operation across all 1 revision of this API.