Coolset Data API (1.0)

Returns all documents for the authenticated company, including file metadata, upload status, and associated entities.

Search (search): full-text search across name and description.

Filters:

• name, name__icontains
• description__icontains
• source, source__in
• content_type, content_type__in
• upload_status
• identifiers__identifier, identifiers__identifier__in, identifiers__identifier__contains
• uploaded_at, uploaded_at__gte, uploaded_at__lte
• created_at, created_at__gte, created_at__lte
• updated_at, updated_at__gte, updated_at__lte

Ordering (ordering): name, source, content_type, upload_status, created_at, updated_at (prefix with - for descending). Default: -created_at.

Creates a new document record and returns a signed upload URL. After uploading the file to the signed URL, call the confirm_upload endpoint to mark the upload as complete.

Returns metadata for a single document by ID (does not include file contents).

Partially update a document's metadata fields (e.g. name, description).

Deletes the document record and its file from storage.

Confirms that the file has been uploaded to the signed URL. Marks the document status as completed and triggers downstream processing.

Generates a time-limited signed URL for downloading the document file. Only available for documents with completed uploads.

Returns a paginated list of financial transactions for the authenticated company. Transactions are the raw financial data that can be classified as carbon emissions. Use the 'search' parameter to search across vendor_name, ledger, and description. Filter with query parameters:

• vendor_name: Filter by vendor name (supports exact, icontains, istartswith, iendswith, isnull)
• ledger: Filter by ledger (supports exact, icontains, istartswith, iendswith)
• journal: Filter by journal (supports exact, icontains, istartswith, iendswith, isnull)
• description: Filter by description (supports exact, icontains, istartswith, iendswith, isnull)
• source: Filter by source (exact match)
• integration_id: Filter by integration ID (exact match)
• integration__name: Filter by integration name (supports exact, icontains, istartswith, iendswith)
• date: Filter by date (supports exact, gte, lte)
• net_amount: Filter by net amount (supports exact, gt, lt, gte, lte)
• tags: Filter by tag IDs (multi-value, conjoined — transaction must have ALL specified tags)
• confidence_status: Filter by emission confidence status
• classified: true to return only transactions with active emissions, false for unclassified transactions only Supports ordering by: vendor_name, ledger, description, total_co2_kg, date, net_amount. Default ordering: date descending.

Returns transaction rows aggregated by one or more dimensions (ledger, vendor_name, journal, source, currency). Pair with delimit_by=yearly|monthly|daily to also bucket by a truncated period date. Use this endpoint to discover unique bundles of unclassified transactions before driving bulk classification: combine classified=false with a multi-valued group_by and ordering=-count to process the largest bundles first.

Returns a paginated list of data import runs for the authenticated company, ordered by most recent first. Each run includes its status, source, and processing results.

Initiates a new data import run for bulk data ingestion.

Returns a single data import run by ID with full processing details.

Executes a retrieval or generation query against the authenticated company's corpus. Accepts query_text, mode (retrieval or generation), top_k, vector_distance_threshold, optional file_ids to scope the search by Vertex AI file name, and optional document_ids to scope the search by Document ID.