AUautarc
Files

Upload a file

Uploads a file's binary content and attaches it to a project in one call. An alternative to the two-step presigned-URL flow (see the upload-url endpoints in the Room Scans / Files documentation) for integrators that prefer sending the binary directly. category is not accepted: the created file always has category=project. fileType must be an allowed autarc_file_type label (see UploadFileType); personnel types are rejected.

post/files

Request

  • Base URL
    https://api3.autarc.energy/v1
  • Auth
    API key in header X-Api-Key

Request body multipart/form-data

projectIdstring uuid required

The project to attach the file to.

namestring

Display name shown in the project's documents. Defaults to the uploaded filename if omitted.

fileType'quote' | 'instructionManual' | 'vdzForm' | 'image' | 'energyBill' | 'energyCertificate' | 'technicalPlanning' | 'hydraulicSchema' | 'commissioningReport' | 'installation' | 'supplierQuote' | 'powerOfAttorney' | 'drawing' | 'heatpumpReport' | 'heatpumpCheck' | 'technicalFeasibility' | 'floorPlan' | 'heatpumpSimulation' | 'supplyAndServiceContract' | 'other' | 'heatingSurfaceReport' | 'bzaConfirmation' | 'subsidyCertificate' | 'solarPlanningBackgroundGoogle' | 'subsidyProofInvoice' | 'subsidyProofVdzForm' | 'subsidyProofCalculationDocument' | 'subsidyProofNewSystemPhoto' | 'subsidyProofSeasonalPerformanceFactor' | 'subsidyProofDisposalConfirmation' | 'subsidyProofChecklist' | 'subsidyProofConfirmation' | 'supplyAndServiceContractGeneratedPdf' | 'offerCoverPage' | 'solarPlanningScreenshot' | 'offerCoverImage' | 'solarPlanningBackgroundUser' | 'solarPlanningBackgroundOrtho' | 'teamImage' | 'personalSignature' | 'energyDemandCertificate' | 'energyCertificateAdditionalAttachment' | 'feedbackImage' | 'fieldWorkerApp' | 'notImportedRadiator' | 'floorPlanAnalyze' | 'droneScanBundleUser' | 'mcsHeatloadPdf' | 'buildingControlCertificateHeatPump' | 'buildingControlCertificateCylinder' | 'buildingControlCertificateElectrics' | 'buildingControlCertificateExtraAttachment' | 'mcsCertificate' | 'invoice' | 'heatPumpUserManual' | 'cylinderUserManual' | 'maintenanceService' | 'maintenanceChecklist' | 'signedOffer' | 'dnoApprovalLetter' | 'heatPumpCommissioningReport' | 'cylinderCommissioningReport' | 'extraAttachmentCommissioningReport' | 'heatPumpWarranty' | 'cylinderWarranty' | 'extraAttachmentWarranty' | 'mcsHandoverPack' | 'soundAssessmentPosition' | 'acceptedOffer' | 'siteSurveyPhotos' | 'mainsWater' | 'siteSurveyHeatingSystems' | 'heatPumpLocation' | 'condensateDrain' | 'cylinderLocation' | 'mainFuse' | 'earthingArrangement' | 'consumerUnit' | 'photoOfTheBuilding' | 'installationJobPhoto' | 'photogrammetryBundle' | 'droneScanBundleAutarc' | 'solarPlanningBackgroundGoogleOrthomap' | 'postSiteSurveySignature' | 'checkOfferTemplateImage' | 'customerHandoverClientSignature' | 'customerHandoverCompanySignature' | 'solarPlanningFluxOverlay' | 'commissioningProtocolTechnicianSignature' | 'jobReportSignature' | 'solarPlanningTerrainDsm' | 'jobDocument' | 'solarPlanningPhoto' | 'offerCustomerSignature' | 'mcsHeatloadCoverImage' | 'productDataSheet' | 'productWarrantyDocument' | 'productUserManual' | 'consumerCodeCertificate' | 'mcsManualFloorPlan' | 'solarPlanningBackgroundMapboxSatellite' | 'gridRegistrationDocument' | 'solarPlanningBackgroundFrenchOrtho' | 'dnoApplicationForm' | 'dnoApplicationInstallerSignature' | 'productImage' | 'solarPlanningBackgroundLuxembourgOrtho' | 'solarPlanningBackgroundSwitzerlandOrtho' | 'solarPlanningBackgroundPolandOrtho' | 'projectChatPhoto' | 'projectChatFile' | 'signableDocument' | 'signableDocumentSignature' | 'signableDocumentStamped' | 'reviewRewardScreenshot' | 'reviewRewardVideo' | 'mcsSolarCertificate' | 'mcsSolarVerificationCertificate' | 'mcsSolarArrayTestReport' | 'mcsSolarElectricalInstallationCertificate' | 'solarCommissioningReport' | 'buildingControlCertificateSolar' | 'solarPlanningBackgroundAustriaOrtho' | 'solarPlanningPortalImage' | 'dnoCutOutPhoto' | 'dnoHeatPumpDatasheet' | 'maintenanceContract' | 'companyStamp' | 'productModel3d' | 'coolingOutdoorUnitPhoto' | 'coolingIndoorUnitPhoto' | 'coolingElectricalConnectionPhoto' | 'coolingCableRoutingPhoto' | 'insuranceBackedGuaranteeCertificate' | 'depositProtectionCertificate' | 'publicLiabilityInsuranceCertificate' | 'employersLiabilityInsuranceCertificate' | 'otherInsuranceCertificate' | 'companyTermsAndConditions' | 'companyCancellationForm' | 'companyComplaintsProcedure' | 'companyPersonalDataNotice' | 'mcsNonConformityEvidence' | 'mcsFeedbackAttachment' | 'mcsInternalReviewAttachment' | 'mcsPolicyDocument' | 'installationPack' | 'mcsStructuralCheckReport' | 'mcsSolarMaintenanceInstructions' | 'mcsSolarMaintenanceServices' | 'coolingFloorPlan' | 'coolingCheck' | 'mountingBomReport' | 'solarPlanningBackgroundAppleMaps' | 'productModel3dThumbnail' | 'solarPlanningBackgroundPerspectivePhoto' | 'billOfMaterialsReport' | 'acSimulation' | 'letterOfAuthorityPdf' | 'letterOfAuthoritySignedPdf' | 'serviceLifecycleDocument' | 'scottyDataUpload' | 'scottyGeneratedFile' | 'consultationSitePhoto' | 'vehicleRegistration' | 'vehicleInsurance' | 'vehicleInspectionReport' | 'vehicleInvoice' | 'structuralLoadReport' | 'solarPlanningBackgroundBluesky5cm' | 'solarPlanningBackgroundBluesky12_5cm' | 'solarPlanningTerrainDsmBluesky' | 'video' | 'eInvoiceXml' | 'professionalIndemnityInsuranceCertificate' | 'subcontractorRegistrationCertificate' | 'subcontractorInsuranceEvidence' | 'riskAssessment' | 'methodStatement' | 'uploadedPersonalSignature' | 'mcsSolarReport' | 'mcsPerformanceEstimate' | 'mcsSignature' | 'mcsWorkmanshipGuarantee' | 'g3Certificate' | 'mcsCommissioningRecordUpload' | 'mcsCommissioningPhoto' | 'evStatementOfCompliance' | 'evElectricalInstallationCertificate' | 'evBuildingControlCertificate' | 'evDnoNotification' | 'mcsTechnicalDocumentation' | 'mcsBatteryCertificate' | 'buildingControlCertificateBattery' | 'dnoHeatPumpApprovalLetter' | 'hesApprovalDocument' | 'heatPumpGrantDocument' | 'asInstalledPhoto' | 'generationMeterPhoto' | 'mcsPipePlanningReport' | 'dicoAnnex' | 'dicoBundle' | 'companyVisuraCamerale' | 'purchaseOrderConfirmation'

autarc_file_type labels accepted by POST /v1/files. Defaults to image for image mime types, other otherwise. Personnel types (employmentContract, contractAmendment, personnelDocument) are rejected because they require category=personnel, which this endpoint never sets.

filestring binary required

The file content. Accepted mime types: image/jpeg, image/png, image/webp, image/heic, image/heif, application/pdf, text/csv, text/plain, application/msword, .docx, application/vnd.ms-excel, .xlsx. Max size 100MB.

Response

The created file

idstring uuid required
companyIdstring uuid required
namestring nullable
mimestring required
createdAtstring date-time required
updatedAtstring date-time required
projectIdstring uuid nullable
roomIdstring uuid nullable
type'quote' | 'instructionManual' | 'vdzForm' | 'image' | 'energyBill' | 'energyCertificate' | 'technicalPlanning' | 'hydraulicSchema' | 'commissioningReport' | 'installation' | 'supplierQuote' | 'powerOfAttorney' | 'drawing' | 'heatpumpReport' | 'heatpumpCheck' | 'technicalFeasibility' | 'floorPlan' | 'heatpumpSimulation' | 'supplyAndServiceContract' | 'other' | 'heatingSurfaceReport' | 'bzaConfirmation' | 'subsidyCertificate' | 'solarPlanningBackgroundGoogle' | 'subsidyProofInvoice' | 'subsidyProofVdzForm' | 'subsidyProofCalculationDocument' | 'subsidyProofNewSystemPhoto' | 'subsidyProofSeasonalPerformanceFactor' | 'subsidyProofDisposalConfirmation' | 'subsidyProofChecklist' | 'subsidyProofConfirmation' | 'supplyAndServiceContractGeneratedPdf' | 'offerCoverPage' | 'solarPlanningScreenshot' | 'offerCoverImage' | 'solarPlanningBackgroundUser' | 'solarPlanningBackgroundOrtho' | 'teamImage' | 'personalSignature' | 'energyDemandCertificate' | 'energyCertificateAdditionalAttachment' | 'feedbackImage' | 'fieldWorkerApp' | 'notImportedRadiator' | 'floorPlanAnalyze' | 'droneScanBundleUser' | 'mcsHeatloadPdf' | 'buildingControlCertificateHeatPump' | 'buildingControlCertificateCylinder' | 'buildingControlCertificateElectrics' | 'buildingControlCertificateExtraAttachment' | 'mcsCertificate' | 'invoice' | 'heatPumpUserManual' | 'cylinderUserManual' | 'maintenanceService' | 'maintenanceChecklist' | 'signedOffer' | 'dnoApprovalLetter' | 'heatPumpCommissioningReport' | 'cylinderCommissioningReport' | 'extraAttachmentCommissioningReport' | 'heatPumpWarranty' | 'cylinderWarranty' | 'extraAttachmentWarranty' | 'mcsHandoverPack' | 'soundAssessmentPosition' | 'acceptedOffer' | 'siteSurveyPhotos' | 'mainsWater' | 'siteSurveyHeatingSystems' | 'heatPumpLocation' | 'condensateDrain' | 'cylinderLocation' | 'mainFuse' | 'earthingArrangement' | 'consumerUnit' | 'photoOfTheBuilding' | 'installationJobPhoto' | 'photogrammetryBundle' | 'droneScanBundleAutarc' | 'solarPlanningBackgroundGoogleOrthomap' | 'postSiteSurveySignature' | 'checkOfferTemplateImage' | 'customerHandoverClientSignature' | 'customerHandoverCompanySignature' | 'solarPlanningFluxOverlay' | 'commissioningProtocolTechnicianSignature' | 'jobReportSignature' | 'solarPlanningTerrainDsm' | 'jobDocument' | 'solarPlanningPhoto' | 'offerCustomerSignature' | 'mcsHeatloadCoverImage' | 'productDataSheet' | 'productWarrantyDocument' | 'productUserManual' | 'consumerCodeCertificate' | 'mcsManualFloorPlan' | 'solarPlanningBackgroundMapboxSatellite' | 'gridRegistrationDocument' | 'solarPlanningBackgroundFrenchOrtho' | 'dnoApplicationForm' | 'dnoApplicationInstallerSignature' | 'productImage' | 'solarPlanningBackgroundLuxembourgOrtho' | 'solarPlanningBackgroundSwitzerlandOrtho' | 'solarPlanningBackgroundPolandOrtho' | 'projectChatPhoto' | 'projectChatFile' | 'signableDocument' | 'signableDocumentSignature' | 'signableDocumentStamped' | 'reviewRewardScreenshot' | 'reviewRewardVideo' | 'mcsSolarCertificate' | 'mcsSolarVerificationCertificate' | 'mcsSolarArrayTestReport' | 'mcsSolarElectricalInstallationCertificate' | 'solarCommissioningReport' | 'buildingControlCertificateSolar' | 'solarPlanningBackgroundAustriaOrtho' | 'solarPlanningPortalImage' | 'dnoCutOutPhoto' | 'dnoHeatPumpDatasheet' | 'maintenanceContract' | 'companyStamp' | 'productModel3d' | 'coolingOutdoorUnitPhoto' | 'coolingIndoorUnitPhoto' | 'coolingElectricalConnectionPhoto' | 'coolingCableRoutingPhoto' | 'insuranceBackedGuaranteeCertificate' | 'depositProtectionCertificate' | 'publicLiabilityInsuranceCertificate' | 'employersLiabilityInsuranceCertificate' | 'otherInsuranceCertificate' | 'companyTermsAndConditions' | 'companyCancellationForm' | 'companyComplaintsProcedure' | 'companyPersonalDataNotice' | 'mcsNonConformityEvidence' | 'mcsFeedbackAttachment' | 'mcsInternalReviewAttachment' | 'mcsPolicyDocument' | 'installationPack' | 'mcsStructuralCheckReport' | 'mcsSolarMaintenanceInstructions' | 'mcsSolarMaintenanceServices' | 'coolingFloorPlan' | 'coolingCheck' | 'mountingBomReport' | 'solarPlanningBackgroundAppleMaps' | 'employmentContract' | 'contractAmendment' | 'personnelDocument' | 'productModel3dThumbnail' | 'solarPlanningBackgroundPerspectivePhoto' | 'billOfMaterialsReport' | 'acSimulation' | 'letterOfAuthorityPdf' | 'letterOfAuthoritySignedPdf' | 'serviceLifecycleDocument' | 'scottyDataUpload' | 'scottyGeneratedFile' | 'consultationSitePhoto' | 'vehicleRegistration' | 'vehicleInsurance' | 'vehicleInspectionReport' | 'vehicleInvoice' | 'structuralLoadReport' | 'solarPlanningBackgroundBluesky5cm' | 'solarPlanningBackgroundBluesky12_5cm' | 'solarPlanningTerrainDsmBluesky' | 'video' | 'eInvoiceXml' | 'professionalIndemnityInsuranceCertificate' | 'subcontractorRegistrationCertificate' | 'subcontractorInsuranceEvidence' | 'subcontractorAgreement' | 'riskAssessment' | 'methodStatement' | 'uploadedPersonalSignature' | 'mcsSolarReport' | 'mcsPerformanceEstimate' | 'mcsSignature' | 'mcsWorkmanshipGuarantee' | 'g3Certificate' | 'mcsCommissioningRecordUpload' | 'mcsCommissioningPhoto' | 'evStatementOfCompliance' | 'evElectricalInstallationCertificate' | 'evBuildingControlCertificate' | 'evDnoNotification' | 'mcsTechnicalDocumentation' | 'mcsBatteryCertificate' | 'buildingControlCertificateBattery' | 'dnoHeatPumpApprovalLetter' | 'hesApprovalDocument' | 'heatPumpGrantDocument' | 'asInstalledPhoto' | 'generationMeterPhoto' | 'mcsPipePlanningReport' | 'dicoAnnex' | 'dicoBundle' | 'companyVisuraCamerale' | 'purchaseOrderConfirmation' required

Specific document kind. GET /v1/files may return any autarc_file_type label, including personnel types uploaded from the team member panel.

category'room' | 'project' | 'radiator' | 'product' | 'technicalFeasibilityFloorplan' | 'technicalFeasibilitySolarThermal' | 'technicalFeasibilityFloorHeating' | 'technicalFeasibilityRadiator' | 'technicalFeasibilityValve' | 'technicalFeasibilityOldHeatingTypePlate' | 'technicalFeasibilityDrainPipe' | 'technicalFeasibilityExhaustSystem' | 'technicalFeasibilityPump' | 'technicalFeasibilityNarrowestPassage' | 'technicalFeasibilityLowestPassage' | 'technicalFeasibilityHeatpumpLocationIndoor' | 'technicalFeasibilityHeatpumpLocationOutdoor' | 'technicalFeasibilityHeatpumpLocationSurrounding' | 'technicalFeasibilityBreakthroughSite' | 'technicalFeasibilityOther' | 'technicalFeasibilityOldMeterBox' | 'technicalFeasibilityNewMeterBox' | 'technicalFeasibilityJunctionBox' | 'technicalFeasibilityEarthingBar' | 'companyLogo' | 'profilePicture' | 'technicalFeasibilityOilTank' | 'checkSideImage' | 'offerCoverImage' | 'offerAdditionalAttachment' | 'offer' | 'subsidyApplicationSupplyAndServiceContract' | 'subsidyApplicationOffer' | 'valve' | 'technicalFeasibilityCirculationPipe' | 'teamImage' | 'personalSignature' | 'other' | 'bundle' | 'contactUsImage' | 'proposalImage' | 'postSiteSurveySignature' | 'checkOfferTemplateImage' | 'productPackage' | 'leadEmailAttachment' | 'technicalFeasibilityFireplace' | 'proposalSharedPdf' | 'proposalCoverImage' | 'companyStamp' | 'siteDisposal' | 'technicalFeasibilityOutdoorSensor' | 'personnel' | 'customerPortalDocument' | 'scottyDataUpload' | 'scottyGeneratedFile' | 'vehicle' | 'sickNote' | 'financingBwa' | 'financingLiabilityInsurance' | 'financingInstallationProtocol' | 'financingAcceptanceConfirmation' | 'financingCompanyLogo' | 'documentDesignElement' | 'purchaseOrder' | 'subsidyCheckSharedPdf' required

Owner/context of the file (not a folder hierarchy). Public GET /v1/files returns the company's files of every category listed here; the only list filter is projectId. Public POST /v1/files does not accept this field and always writes category=project.

Changes

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