Nexla

Nexla Credential Mappings API

The credential-mappings API from Nexla — 2 operation(s) for credential-mappings.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.nexla.com/dev-guides/nexla-api
📖
APIReference
https://docs.nexla.com/reference/nexla-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/authentication/nexla-authentication.yml
📖
Documentation
https://docs.nexla.com/genai-rag/
📖
APIReference
https://docs.nexla.com/dev-guides/mcp-tools/tools-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/openapi/nexla-credential-mappings-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/conventions/nexla-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/errors/nexla-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/data-model/nexla-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/asyncapi/nexla-webhooks.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/nexla/refs/heads/main/mcp/nexla-tool-crosswalk.yml

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/nexla-credential-mappings-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

nexla-credential-mappings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nexla GenAI (RAG + MCPaaS) Credential Mappings API
  description: Combined Nexla GenAI RAG API Service and MCPaaS
  version: v0.2.3.3-combined
tags:
- name: credential-mappings
paths:
  /v1/toolsets/{tool_set_id}/tools/{tool_id}/credential-mapping:
    put:
      tags:
      - credential-mappings
      summary: Put Credential Mapping
      description: 'Pin a specific credential for the caller on a specific tool.


        Overrides auto resolution, which would otherwise pick the caller''s most recently

        updated credential for the connector. Takes effect immediately: tool execution reads

        ``runtime_config`` live from the database, so the next call uses the pinned

        credential with no cache flush or export refresh.'
      operationId: put_credential_mapping_v1_toolsets__tool_set_id__tools__tool_id__credential_mapping_put
      parameters:
      - name: tool_set_id
        in: path
        required: true
        schema:
          type: string
          title: Tool Set Id
      - name: tool_id
        in: path
        required: true
        schema:
          type: integer
          title: Tool Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-subject-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Subject-Id
      - name: x-actor-type
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actor-Type
      - name: x-roles
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Roles
      - name: x-client-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Client-Id
      - name: X-Agent-Principal
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Principal
      - name: x-agent-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Id
      - name: x-agent-session-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Session-Id
      - name: x-upstream-app
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Upstream-App
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialMappingIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Put Credential Mapping V1 Toolsets  Tool Set Id  Tools  Tool Id  Credential Mapping Put
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - credential-mappings
      summary: Delete Credential Mapping
      description: Remove the caller's own credential mapping for a tool.
      operationId: delete_credential_mapping_v1_toolsets__tool_set_id__tools__tool_id__credential_mapping_delete
      parameters:
      - name: tool_set_id
        in: path
        required: true
        schema:
          type: string
          title: Tool Set Id
      - name: tool_id
        in: path
        required: true
        schema:
          type: integer
          title: Tool Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-subject-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Subject-Id
      - name: x-actor-type
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actor-Type
      - name: x-roles
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Roles
      - name: x-client-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Client-Id
      - name: X-Agent-Principal
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Principal
      - name: x-agent-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Id
      - name: x-agent-session-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Session-Id
      - name: x-upstream-app
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Upstream-App
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Delete Credential Mapping V1 Toolsets  Tool Set Id  Tools  Tool Id  Credential Mapping Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/toolsets/{tool_set_id}/credential-mappings:
    get:
      tags:
      - credential-mappings
      summary: List Credential Mappings
      description: 'List the caller''s own credential pins across a toolset''s tools.


        Returns one entry per tool that has a runtime credential configuration, with

        ``credential_id`` null where the caller has pinned nothing. Null means "auto" — the

        tool will resolve their latest credential for the connector at call time — **not**

        that the tool is unusable.'
      operationId: list_credential_mappings_v1_toolsets__tool_set_id__credential_mappings_get
      parameters:
      - name: tool_set_id
        in: path
        required: true
        schema:
          type: string
          title: Tool Set Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-subject-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Subject-Id
      - name: x-actor-type
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actor-Type
      - name: x-roles
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Roles
      - name: x-client-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Client-Id
      - name: X-Agent-Principal
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Principal
      - name: x-agent-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Id
      - name: x-agent-session-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Agent-Session-Id
      - name: x-upstream-app
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Upstream-App
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Credential Mappings V1 Toolsets  Tool Set Id  Credential Mappings Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CredentialMappingIn:
      properties:
        credential_id:
          type: integer
          minimum: 1.0
          title: Credential Id
        grant_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Grant Token
          description: Optional token from the credential_required tool result. Carries the connector context so the UI need not re-derive it; it is not authorization on its own and access_scope is re-checked regardless.
      additionalProperties: false
      type: object
      required:
      - credential_id
      title: CredentialMappingIn
      description: Input for registering the caller's own credential mapping.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError