mammoth-io External keys API

openapi: 3.2.0
info:
  title: Mammoth Io External keys API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged External keys 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: External keys
paths:
  /workspaces/{workspace_id}/external_keys:
    get:
      tags:
      - External keys
      summary: Get external keys of the given Workspace ID
      description: This endpoint fetches all external keys added as part of the given Workspace ID
      operationId: GetKeysByWorkspaceId
      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: fields
        in: query
        schema:
          type: string
          title: Fields
          description: Fields to be returned in a comma-separated format. Check full mode for all fields.
          default: __standard
          examples:
          - key_type,key_name,created_by_user_id
          - __standard
        description: Fields to be returned in a comma-separated format. Check full mode for all fields.
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          fields-example-1:
            summary: Return key_type, key_name and created_by_user_id
            value: key_type,key_name,created_by_user_id
          fields-example-2:
            summary: Return Standard representation of external keys
            description: Standard representation includes id,key_type,key_name,description,secure_key,is_in_use,model_id,model_config,created_by_user_id,last_used_at,last_used_by_user_id,created_at
            value: __standard
      - name: limit
        in: query
        schema:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Limit
          description: Max number of result to return
          default: 50
          examples:
          - 10
        description: Max number of result to return
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          limit-example-1:
            summary: Limit returned result count to 10
            value: 10
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0.0
          title: Offset
          description: Distance from the beginning of the list of results
          default: 0
          examples:
          - 10
        description: Distance from the beginning of the list of results
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          offset-example-1:
            summary: Start from 10th result
            value: 10
      - name: sort
        in: query
        schema:
          type: string
          title: Sort by the given fields
          description: Returned results are sorted by the combination of the given fields.
          default: (id:asc)
          examples:
          - (id:asc)
          - (id:asc),(name:asc)
        description: Returned results are sorted by the combination of the given fields.
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          sort-example-1:
            summary: Sort by <Resource>.id asc
            value: (id:asc)
          sort-example-2:
            summary: Sort by <Resource>_id and <Resource>_name asc
            value: (id:asc),(name:asc)
      - name: key_type
        in: query
        schema:
          oneOf:
          - $ref: '#/components/schemas/ExternalKeyType'
          - type: 'null'
        required: false
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalKeysPaginated'
        '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: {}
        '401':
          description: Authorization error
      deprecated: false
    post:
      tags:
      - External keys
      summary: Add external keys to access the intended services
      description: External keys that lets Mammoth to user certain services. User brings their own key to access the service e.g AI based rules need an Open AI key
      operationId: AddExternalKey
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddExternalKeySpec'
        required: true
      responses:
        '201':
          description: Successful create
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalKey'
        '400':
          description: Bad Request
        '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: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    ExternalKeyType:
      type: string
      enum:
      - open_ai
      - anthropic
      - gemini
      - grok
      maxLength: 100
      minLength: 1
      title: ExternalKeyType
      description: Type of the external key e.g. open_ai
      examples:
      - value: open_ai
    ExternalKeysPaginated:
      properties:
        limit:
          type: integer
          exclusiveMinimum: 0.0
          title: Page size
          description: Setting limit would limit the items received in the page
          default: 10
          examples:
          - summary: Limit page size to 10
            value: 10
        offset:
          type: integer
          minimum: 0.0
          title: Page offset
          description: First position to return from the results
          default: 0
          examples:
          - summary: Sets the first position to return from the results to 0
            value: 0
        next:
          type: string
          title: Next url
          description: Url of the next page
          examples:
          - summary: Next url will retrieve results with limit 10 and offset 5
            value: <url>?limit=10&offset=5
        external_keys:
          items:
            $ref: '#/components/schemas/ExternalKey'
          type: array
        providers:
          oneOf:
          - items:
              type: object
            type: array
          - type: 'null'
          description: Available LLM providers with their models and config capabilities. Only included when fields=__full.
        house_keys:
          items:
            $ref: '#/components/schemas/HouseKey'
          type: array
          description: Mammoth-owned house keys available as a fallback for GenAI requests with no pinned api_key_id. Currently always a single open_ai entry, since the house key is OpenAI-only. is_in_use on this list and on external_keys are mutually exclusive per key_type — exactly one is True at a time.
      type: object
      required:
      - external_keys
      - next
      title: ExternalKeysPaginated
    AddExternalKeySpec:
      properties:
        key_type:
          $ref: '#/components/schemas/ExternalKeyType'
        key_name:
          type: string
          maxLength: 100
          minLength: 1
          description: A name to be associated with the key
          examples:
          - value: Mammmoth Open AI
        description:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 200
          minLength: 1
          description: Describe the purpose of the key and any added information related to it
        secure_key:
          type: string
          maxLength: 500
          minLength: 3
          description: The key value which will be used in the intended service
          examples:
          - value: abcDefGhiJklMnoPqrStuVwxYz1234567890
        model_id:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 100
          minLength: 1
          description: The specific LLM model to use with this key e.g. claude-haiku-4-5. Defaults to the provider's recommended model if not specified.
        model_config:
          oneOf:
          - $ref: '#/components/schemas/ModelConfigSpec'
          - type: 'null'
          description: Optional model configuration overrides (thinking_budget, web_search, etc.)
      type: object
      required:
      - key_name
      - key_type
      - secure_key
      title: AddExternalKeySpec
      description: External key specification
      examples:
      - key_type: open_ai
        key_name: My Open AI key
        description: null
        secure_key: abcDefGhiJklMnoPqrStuVwxYz1234567890
        model_id: gpt-5.4-mini
        model_config_data: null
    ExternalKey:
      properties:
        id:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: 1
          description: ID of the external key as saved in the DB
          examples:
          - value: 10
        key_type:
          oneOf:
          - $ref: '#/components/schemas/ExternalKeyType'
          - type: 'null'
          maxLength: 100
          minLength: 1
          description: Type of the external key e.g. open_ai
          examples:
          - value: open_ai
        key_name:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 100
          minLength: 1
          description: A name to be associated with the key
          examples:
          - value: Mammmoth Open AI
        description:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 200
          minLength: 1
          description: Describe the purpose of the key and any added information related to it
        secure_key:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          minLength: 3
          description: The key value which will be used in the intended service
          examples:
          - value: abcDefGhiJklMnoPqrStuVwxYz1234567890
        is_in_use:
          oneOf:
          - type: boolean
          - type: 'null'
          description: Is the key currently in use?
        model_id:
          oneOf:
          - type: string
          - type: 'null'
          description: The specific LLM model bound to this key e.g. claude-haiku-4-5
        model_config_data:
          oneOf:
          - $ref: '#/components/schemas/ModelConfigSpec'
          - type: 'null'
          description: Optional model configuration overrides
        created_by_user_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: ID of the user that created this key
        last_used_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: When was the key last used at?
        last_used_by_used_id:
          oneOf:
          - type: integer
          - type: 'null'
          description: ID of the user who the key in the recent most usage?
        created_at:
          oneOf:
          - type: string
            format: date-time
          - type: 'null'
          description: When was the key created? Null for keys created before this was recorded.
      type: object
      required: []
      title: ExternalKey
    HouseKey:
      properties:
        key_type:
          $ref: '#/components/schemas/ExternalKeyType'
        is_in_use:
          type: boolean
          description: Whether a GenAI request with no pinned api_key_id would use this house key (True), because the workspace has no in-use key of this key_type of its own, or the workspace's own key (False).
          examples:
          - value: true
      type: object
      required:
      - is_in_use
      - key_type
      title: HouseKey
    ModelConfigSpec:
      properties:
        thinking_budget:
          oneOf:
          - type: integer
          - type: 'null'
          minimum: -1
          description: Maximum thinking tokens (Anthropic/Gemini models). Use -1 for Gemini dynamic mode.
        thinking_level:
          oneOf:
          - type: string
          - type: 'null'
          description: 'Thinking level: minimal, low, medium, high (Gemini v3 models; minimal is Flash-only).'
        reasoning_effort:
          oneOf:
          - type: string
          - type: 'null'
          description: 'Reasoning effort: low, high (Grok reasoning models).'
        web_search:
          oneOf:
          - type: boolean
          - type: 'null'
          description: Enable live web search grounding (supported models only).
        cached_input:
          oneOf:
          - type: boolean
          - type: 'null'
          description: Enable prompt caching for repeated input prefixes to reduce cost (supported models only).
      type: object
      required: []
      title: ModelConfigSpec
  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