mammoth-io

mammoth-io Annotations API

The Annotations API from mammoth-io — 3 operation(s) for annotations.

GitHub OpenAPI

Operations 5

POST /workspaces/{workspace_id}/projects/{project_id}/annotations/{annotation_id}/comments Add comment #
GET /workspaces/{workspace_id}/projects/{project_id}/annotations List annotations #
POST /workspaces/{workspace_id}/projects/{project_id}/annotations Create annotation #
DELETE /workspaces/{workspace_id}/projects/{project_id}/annotations/{annotation_id} Delete annotation #
PATCH /workspaces/{workspace_id}/projects/{project_id}/annotations/{annotation_id} Update annotation status #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/mammoth-io/openapi/mammoth-io-annotations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-workspace-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-datasets-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-activity-filters-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-automation-creation-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-dataview-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/mammoth-io/json-schema/mammoth-io-update-plan-request-schema-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-annotations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mammoth-io-annotations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mammoth Io Annotations API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Annotations 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: Annotations
paths:
  /workspaces/{workspace_id}/projects/{project_id}/annotations/{annotation_id}/comments:
    post:
      tags:
      - Annotations
      summary: Add comment
      description: Add a comment to an existing annotation thread.
      operationId: AddComment
      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: annotation_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCommentRequest'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnotationCommentResponse'
        '404':
          description: Nothing matches the given URI
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Not Found Exception
                examples:
                - status_code: 404
                  detail: Not Found
                  extra: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                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}/annotations:
    get:
      tags:
      - Annotations
      summary: List annotations
      description: List annotations in a project, optionally filtered by target.
      operationId: ListAnnotations
      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: target_type
        in: query
        schema:
          oneOf:
          - type: string
          - type: 'null'
          description: 'Filter by resource type: dataset, dataview, or workflow'
        description: 'Filter by resource type: dataset, dataview, or workflow'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      - name: target_id
        in: query
        schema:
          oneOf:
          - type: integer
          - type: 'null'
          description: Filter by resource ID
        description: Filter by resource ID
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AnnotationResponse'
                type: array
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                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
    post:
      tags:
      - Annotations
      summary: Create annotation
      description: Create an annotation thread on a dataset, dataview, or workflow.
      operationId: CreateAnnotation
      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:
              $ref: '#/components/schemas/CreateAnnotationRequest'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnotationResponse'
        '422':
          description: Server is not able to process the contained instructions
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Unprocessable Entity
                examples:
                - status_code: 422
                  detail: Unprocessable Content
                  extra: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                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}/annotations/{annotation_id}:
    delete:
      tags:
      - Annotations
      summary: Delete annotation
      description: Delete an annotation and all its comments.
      operationId: DeleteAnnotation
      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: annotation_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '204':
          description: Request fulfilled, nothing follows
          headers: {}
        '404':
          description: Nothing matches the given URI
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Not Found Exception
                examples:
                - status_code: 404
                  detail: Not Found
                  extra: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                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
    patch:
      tags:
      - Annotations
      summary: Update annotation status
      description: Resolve or reopen an annotation.
      operationId: PatchAnnotation
      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: annotation_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchAnnotationRequest'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnotationResponse'
        '404':
          description: Nothing matches the given URI
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Not Found Exception
                examples:
                - status_code: 404
                  detail: Not Found
                  extra: {}
        '400':
          description: Bad request syntax or unsupported method
          content:
            application/json:
              schema:
                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:
    AnnotationCommentResponse:
      properties:
        id:
          type: integer
        annotation_id:
          type: integer
        body:
          type: string
        created_by:
          type: integer
        created_at:
          oneOf:
          - type: string
          - type: 'null'
      type: object
      required:
      - annotation_id
      - body
      - created_by
      - id
      title: AnnotationCommentResponse
    AnnotationResponse:
      properties:
        id:
          type: integer
        target_type:
          type: string
        target_id:
          type: integer
        project_id:
          type: integer
        status:
          type: string
        resolved_by:
          oneOf:
          - type: integer
          - type: 'null'
        resolved_at:
          oneOf:
          - type: string
          - type: 'null'
        created_by:
          type: integer
        created_at:
          oneOf:
          - type: string
          - type: 'null'
        comments:
          items:
            $ref: '#/components/schemas/AnnotationCommentResponse'
          type: array
      type: object
      required:
      - created_by
      - id
      - project_id
      - status
      - target_id
      - target_type
      title: AnnotationResponse
    AnnotationTargetType:
      type: string
      enum:
      - dataset
      - dataview
      - workflow
      title: AnnotationTargetType
      description: 'Type of the annotated resource: dataset, dataview, or workflow'
    AddCommentRequest:
      properties:
        body:
          type: string
          description: Comment text
      type: object
      required:
      - body
      title: AddCommentRequest
    AnnotationStatus:
      type: string
      enum:
      - open
      - resolved
      title: AnnotationStatus
      description: 'New status: open or resolved'
    PatchAnnotationRequest:
      properties:
        status:
          $ref: '#/components/schemas/AnnotationStatus'
      type: object
      required:
      - status
      title: PatchAnnotationRequest
    CreateAnnotationRequest:
      properties:
        target_type:
          $ref: '#/components/schemas/AnnotationTargetType'
        target_id:
          type: integer
          description: ID of the annotated resource
        body:
          type: string
          description: Initial comment body
      type: object
      required:
      - body
      - target_id
      - target_type
      title: CreateAnnotationRequest
  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