Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.isometric.com/llms.txt

Use this file to discover all available pages before exploring further.

Sources are required to provide supporting evidence for the datapoints submitted for your project’s MRV, fine grained calculations or inventories of materials. The process below outlines how to upload a source file and attach it to a datapoint:
1

Create Source

First call the POST Source endpoint to create a source reference object. In the request, make sure to:
  • Set the __typename parameter to CreateDocumentSourceRequest
  • Include the content_length parameter (i.e. file size in bytes): this value is checked during the file upload step
  • Choose a display name: this name will be shown in the registry
  • Provide the file name of the upload: this value will be checked in the upload step
You should also decide whether the source should be publicly visible in the registry when credits are issued. Sources are hidden by default but can be made public by setting is_public to true.
2

Upload source file

The response to the above request will include a signed_upload_url field for a Google Cloud Storage bucket. To upload the source file, make a PUT request to the URL as follows:
curl
curl --request PUT \
  --url 'https://storage.googleapis.com/...' \
  --header 'Content-Type: xxx/yyy' \
  --data-binary 'local/file/path'
If you are making the PUT request via an API client that implements chunked transfers, you may also need to prevent chunking by explicitly setting the Content-Length header in addition to the Content-Type.
3

Attach to a datapoint

When creating a datapoint, sources can be attached by passing the source ID (src_xxxx) in the source_ids array.

​
Supported filetypes

The following filetypes are currently supported as evidence sources:
File typeExtensionContent-Type header
Plain text file.txttext/plain
PDF document.pdfapplication/pdf
MS Word OpenXML document.docxapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
MS Word document.docapplication/msword
JPEG image.jpeg, .jpgimage/jpeg
PNG image.pngimage/png
HEIC image.heicimage/heic
CSV file.csvtext/csv
Parquet data file.parquetapplication/vnd.apache.parquet
MS Excel OpenXML spreadsheet.xlsxapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet
MS Excel spreadsheet.xlsapplication/vnd.ms-excel
JSON.jsonapplication/json
GeoJSON.geojsonapplication/geo+json
Interactive Python notebook.ipynbapplication/x-ipynb+json
TIFF image.tif, .tiffimage/tiff
KML file.kmlapplication/vnd.google-earth.kml+xml
GeoPackage.gpkgapplication/geopackage+sqlite3
Shapefile.shpapplication/x-esri-shape
Shapefile index.shxapplication/x-esri-shape
dBASE table.dbfapplication/x-dbf
Shapefile projection.prjapplication/x-esri-prj
Shapefile code page.cpgapplication/x-esri-cpg