mammoth-io External key API
The External key API from mammoth-io — 1 operation(s) for external key.
The External key API from mammoth-io — 1 operation(s) for external key.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-external-key-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mammoth Io External key API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged External key 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 key
paths:
/workspaces/{workspace_id}/external_keys/{key_id}:
get:
tags:
- External key
summary: Get the given external key
description: Fetches information about an external_key, optionally returns validation info
operationId: GetExternalKey
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: key_id
in: path
schema:
type: integer
minimum: 0.0
title: ExternalKeyId
description: Id of an external key
examples:
- 121
description: Id of an external key
required: true
deprecated: false
examples:
key_id-example-1:
value: 121
- name: validate
in: query
schema:
oneOf:
- type: boolean
description: When True, Validates the key
examples:
- true
- type: 'null'
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalKeyResp'
'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: {}
'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: {}
'401':
description: Authorization error
deprecated: false
delete:
tags:
- External key
summary: Delete an external key
description: Delete an external key from the DB. Doesnt not delete the corresponding key from the service
operationId: DeleteExternalKey
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: key_id
in: path
schema:
type: integer
minimum: 0.0
title: ExternalKeyId
description: Id of an external key
examples:
- 121
description: Id of an external key
required: true
deprecated: false
examples:
key_id-example-1:
value: 121
responses:
'204':
description: Request fulfilled, nothing follows
headers: {}
'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: {}
'200':
description: Successful delete
'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
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
ExternalKeyValidationInfo:
properties:
is_key_valid:
type: boolean
error_code:
oneOf:
- type: string
- type: 'null'
error_message:
oneOf:
- type: string
- type: 'null'
type: object
required:
- is_key_valid
title: ExternalKeyValidationInfo
ExternalKeyResp:
properties:
external_key:
$ref: '#/components/schemas/ExternalKey'
validation_info:
oneOf:
- $ref: '#/components/schemas/ExternalKeyValidationInfo'
- type: 'null'
type: object
required:
- external_key
title: ExternalKeyResp
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