mammoth-io Dataset Interpretation API
The DatasetInterpretation API from mammoth-io — 2 operation(s) for datasetinterpretation.
The DatasetInterpretation API from mammoth-io — 2 operation(s) for datasetinterpretation.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-datasetinterpretation-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mammoth Io Dataset Interpretation API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged DatasetInterpretation across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
apiSecret: []
workspaceId: []
tags:
- name: DatasetInterpretation
paths:
/workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/interpretation:
patch:
tags:
- DatasetInterpretation
summary: Confirm dataset interpretation
description: Apply the confirmed SheetStructureMap to the full original file and finalize the dataset, moving it out of HAS_UNSTRUCTURED_DATA. With mode 'original', keep the file in its original, uploaded layout instead; later files for the dataset are ingested the same way.
operationId: ConfirmDatasetInterpretation
parameters:
- name: workspace_id
in: path
schema:
type: integer
minimum: 1.0
title: Workspace ID
description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
examples:
- 4
description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
required: true
deprecated: false
examples:
workspace_id-example-1:
summary: Sample workspace ID
value: 4
- name: project_id
in: path
schema:
type: integer
minimum: 1.0
title: Project ID
description: Project ID of the workspace
examples:
- 4
description: Project ID of the workspace
required: true
deprecated: false
examples:
project_id-example-1:
summary: Sample project ID
value: 4
- name: dataset_id
in: path
schema:
type: integer
minimum: 0.0
title: Dataset ID
description: Id of the dataset
examples:
- 121
description: Id of the dataset
required: true
deprecated: false
examples:
dataset_id-example-1:
summary: Sample dataset ID
value: 121
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfirmDatasetInterpretationRequest'
required: true
responses:
'200':
description: Request fulfilled, document follows
headers: {}
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
deprecated: false
servers:
- url: /api/v2
/workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/interpretation/preview:
post:
tags:
- DatasetInterpretation
summary: Preview dataset interpretation
description: Given a user instruction, asks the LLM to produce a SheetStructureMap then applies it to cached sample rows. Returns the clean preview rows and the structure map. Persists the run so it survives modal close/reopen.
operationId: PreviewDatasetInterpretation
parameters:
- name: workspace_id
in: path
schema:
type: integer
minimum: 1.0
title: Workspace ID
description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
examples:
- 4
description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
required: true
deprecated: false
examples:
workspace_id-example-1:
summary: Sample workspace ID
value: 4
- name: project_id
in: path
schema:
type: integer
minimum: 1.0
title: Project ID
description: Project ID of the workspace
examples:
- 4
description: Project ID of the workspace
required: true
deprecated: false
examples:
project_id-example-1:
summary: Sample project ID
value: 4
- name: dataset_id
in: path
schema:
type: integer
minimum: 0.0
title: Dataset ID
description: Id of the dataset
examples:
- 121
description: Id of the dataset
required: true
deprecated: false
examples:
dataset_id-example-1:
summary: Sample dataset ID
value: 121
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewDatasetInterpretationRequest'
required: true
responses:
'201':
description: Document created, URL follows
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewDatasetInterpretationResponse'
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
deprecated: false
servers:
- url: /api/v2
components:
schemas:
PreviewDatasetInterpretationRequest:
properties:
structure_map:
oneOf:
- type: object
- type: 'null'
title: Structure Map
description: SheetStructureMap from a suggestion the user selected — no LLM call needed
user_instruction:
oneOf:
- type: string
- type: 'null'
title: User Instruction
description: User's plain-English description — LLM converts this to a SheetStructureMap. If omitted along with structure_map, falls back to the destination dataset's saved recipe instruction (batch-add flow)
row_path:
oneOf:
- items:
type: string
type: array
- type: 'null'
title: Row Path
description: 'JSON/XML sources only: the path of object keys to the repeating records the user picked as rows in the file view ([] for the top level). The default reading of that row set is previewed, with no LLM call'
destination_dataset_id:
oneOf:
- type: integer
- type: 'null'
title: Destination Dataset ID
description: When set, treat this as a batch-replay against the given destination's saved recipe (schema-compatibility classification, auto-filled instruction) instead of first-time scope classification — used when applying another dataset's recipe to an unresolved dataset picked via 'select existing'.
type: object
required: []
title: PreviewDatasetInterpretationRequest
ConfirmDatasetInterpretationRequest:
properties:
mode:
$ref: '#/components/schemas/InterpretationMode'
user_instruction:
oneOf:
- type: string
- type: 'null'
title: User Instruction
description: User's plain-English description of how they want the dataset. If omitted along with structure_map, falls back to the destination dataset's saved recipe instruction (batch-add flow)
structure_map:
oneOf:
- type: object
- type: 'null'
title: Structure Map
description: Confirmed SheetStructureMap to apply to the full file
destination_dataset_id:
oneOf:
- type: integer
- type: 'null'
title: Destination Dataset ID
description: When set, treat this as a batch-replay against the given destination's saved recipe instead of first-time scope classification — used when applying another dataset's recipe to an unresolved dataset picked via 'select existing'.
type: object
required: []
title: ConfirmDatasetInterpretationRequest
PreviewDatasetInterpretationResponse:
properties:
preview_rows:
items:
items:
type: string
type: array
type: array
title: Preview Rows
description: Header + up to 200 data rows as the dataset will look after applying the structure map
total_row_count:
type: integer
title: Total Row Count
description: Total number of data rows in the full result (preview_rows may be a subset)
has_more_rows:
type: boolean
title: Has More Rows
description: The source was too big to count, so total_row_count is the sample's and the source has more rows
default: false
structure_map:
type: object
title: Structure Map
description: The SheetStructureMap the LLM produced
header_types:
items:
type: string
type: array
title: Header Types
description: Column type guesses for the preview_rows header
dependent_resources:
oneOf:
- items:
type: object
type: array
- type: 'null'
title: Dependent Resources
description: Downstream transforms/dataviews that depend on this dataset's columns — only populated when re-editing an already-confirmed recipe, as a non-blocking warning that they'll be affected
type: object
required:
- preview_rows
- structure_map
- total_row_count
title: PreviewDatasetInterpretationResponse
InterpretationMode:
type: string
enum:
- interpreted
- original
title: InterpretationMode
description: '''interpreted'' (default) applies the reviewed reshape; ''original'' keeps the file in its original, uploaded layout and takes no reshape inputs'
default: interpreted
securitySchemes:
bearerAuth:
type: http
description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
scheme: bearer
apiKey:
type: apiKey
description: Deprecated — use bearerAuth.
name: X-API-KEY
in: header
apiSecret:
type: apiKey
description: Deprecated — use bearerAuth.
name: X-API-SECRET
in: header
workspaceId:
type: apiKey
description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
name: X-WORKSPACE-ID
in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json