mammoth-io Sample Flow API

openapi: 3.2.0
info:
  title: Mammoth Io Sample Flow API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Sample Flow 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: Sample Flow
paths:
  /workspaces/{workspace_id}/projects/{project_id}/sample-flow:
    post:
      tags:
      - Sample Flow
      summary: Trigger sample-flow import
      description: Downloads the public sample CSV, creates a future request, and enqueues an async job to ingest it.
      operationId: CreateSampleFlow
      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
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/SampleFlowRequest'
              - type: 'null'
        required: true
      responses:
        '200':
          description: Sample flow request accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SampleFlowResponseData'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    SampleFlowResponseData:
      properties:
        name:
          type: string
          minLength: 1
          title: File name
          description: Name of the downloaded sample file.
        job_id:
          type: integer
          minimum: 1.0
          title: Job ID
          description: ID of the created async job for ingesting the sample file.
      type: object
      required:
      - job_id
      - name
      title: SampleFlowResponseData
    SampleFlowRequest:
      properties:
        label_resource_id:
          oneOf:
          - type: integer
          - type: 'null'
          title: Label Resource ID
          description: Optional parent label/folder resource to place the imported file under.
          examples:
          - summary: Sample folder
            value: 456
      type: object
      required: []
      title: SampleFlowRequest
      description: Sample flow request body
      examples:
      - label_resource_id: 123
  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