mammoth-io Agent access API

openapi: 3.2.0
info:
  title: Mammoth Io Agent access API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Agent access 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: Agent access
paths:
  /agents/access/requests/{request_id}/project-context:
    post:
      tags:
      - Agent access
      summary: Add a thumbs-down's correction to the project's agent context (owners and…
      description: Keeps the comment of a feedback request in the project's agent context, which every agent reading the project gets, and marks the request done.
      operationId: AddAgentRequestToProjectContext
      parameters:
      - name: request_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRequestItem'
        '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: {}
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /agents/access/requests:
    get:
      tags:
      - Agent access
      summary: List the workspace's agent requests (owners and admins)
      operationId: ListAgentAccessRequests
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - open
          - done
          - declined
          - dismissed
          default: open
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AgentRequestItem'
                type: array
        '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: {}
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    post:
      tags:
      - Agent access
      summary: Ask for access or a change, or flag an answer, from the chat
      description: Any member. The same person asking the same thing of the same turn again gets the open request back. An access or change request tells the workspace's owners and admins (and a change, the file's keeper).
      operationId: CreateAgentAccessRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentRequest'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRequestItem'
        '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: {}
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /agents/access/requests/mine:
    get:
      tags:
      - Agent access
      summary: The caller's own requests made from one chat
      operationId: ListMyAgentAccessRequests
      parameters:
      - name: session_id
        in: query
        schema:
          type: string
          minLength: 1
        required: true
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AgentRequestItem'
                type: array
        '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: {}
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /agents/access/requests/{request_id}:
    patch:
      tags:
      - Agent access
      summary: Close a request (owners, admins and the file's keeper)
      operationId: ResolveAgentAccessRequest
      parameters:
      - name: request_id
        in: path
        schema:
          type: integer
        required: true
        deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResolveAgentRequest'
        required: true
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRequestItem'
        '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: {}
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
  /agents/access/saved-charts:
    post:
      tags:
      - Agent access
      summary: Save the chart of an answer to my own dashboard (Explore level)
      description: The chart is drawn by the dashboard builder from the intent alone, in the background. With no `dashboard_id` a new dashboard of the person's own is made; with one, it must be a dashboard they saved before.
      operationId: SaveAgentChart
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveChartRequest'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveChartResponse'
        '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: {}
        '403':
          description: Request forbidden -- authorization will not help
          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: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    SaveChartRequest:
      properties:
        session_id:
          type: string
          minLength: 1
        turn_id:
          type: string
          minLength: 1
        dashboard_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
        new_dashboard_name:
          type: string
          maxLength: 200
          default: ''
      type: object
      required:
      - session_id
      - turn_id
      title: SaveChartRequest
    AgentRequestItem:
      properties:
        id:
          type: integer
        kind:
          type: string
          enum:
          - access
          - change
          - feedback
        requester:
          $ref: '#/components/schemas/PersonRef'
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
        project_name:
          oneOf:
          - type: string
          - type: 'null'
        file_id:
          oneOf:
          - type: integer
          - type: 'null'
        file_name:
          oneOf:
          - type: string
          - type: 'null'
        owners:
          items:
            $ref: '#/components/schemas/PersonRef'
          type: array
        asked:
          oneOf:
          - type: string
          - type: 'null'
        text:
          type: string
        session_id:
          oneOf:
          - type: string
          - type: 'null'
        turn_id:
          oneOf:
          - type: string
          - type: 'null'
        status:
          type: string
        created_at:
          type: string
          format: date-time
        resolved_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
        resolved_by:
          oneOf:
          - $ref: '#/components/schemas/PersonRef'
          - type: 'null'
        keeper:
          oneOf:
          - $ref: '#/components/schemas/PersonRef'
          - type: 'null'
      type: object
      required:
      - created_at
      - id
      - kind
      - requester
      - status
      - text
      title: AgentRequestItem
    PersonRef:
      properties:
        id:
          type: integer
        name:
          type: string
      type: object
      required:
      - id
      - name
      title: PersonRef
    ResolveAgentRequest:
      properties:
        status:
          type: string
          enum:
          - done
          - declined
          - dismissed
      type: object
      required:
      - status
      title: ResolveAgentRequest
    CreateAgentRequest:
      properties:
        kind:
          type: string
          enum:
          - access
          - change
          - feedback
        project_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
        file_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
        asked:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 200
          minLength: 1
        text:
          type: string
          maxLength: 2000
          minLength: 1
        session_id:
          oneOf:
          - type: string
          - type: 'null'
          minLength: 1
        turn_id:
          oneOf:
          - type: string
          - type: 'null'
          minLength: 1
        dashboard_id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
      type: object
      required:
      - kind
      - text
      title: CreateAgentRequest
    SaveChartResponse:
      properties:
        dashboard_id:
          type: integer
      type: object
      required:
      - dashboard_id
      title: SaveChartResponse
  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