Dataviews
generate AI Data

Generate AI-based Suggestions for Dataview

Given the prompt, generate AI data against a sequence number in the pipeline

post/workspaces/{workspace_id}/projects/{project_id}/suggestions

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/suggestions
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
project_idinteger required

Project ID of the workspace

Example:4

Query parameters

dataset_idinteger nullable

Id of the dataset

Example:121
dataview_idinteger

Dataview ID of the dataset

Example:4

Request body

suggestion_type'extract_text' | 'add_condition' | 'generate_task' | 'apply_ai_template' | 'derivative_fuzzy_bucket' | 'date_format' | 'json_suggest' required

Type of operation (extraction or conditional filtering)

Example request

{
  "suggestion_type": "extract_text",
  "params": {
    "column_name": "comments",
    "sequence_number": 1,
    "prompt": "Extract all mentions of product issues",
    "edit_regex": null
  }
}

Response

The request was processed successfully, but a valid regex pattern could not be generated

object required

Changes

No recorded changes to this operation across all 4 revisions of this API.