Paragon Proxy API

naftiko: 1.0.0-alpha2
info:
  label: Paragon Proxy API
  description: The Proxy API allows you to directly access any of the third-party provider's API methods on behalf of your
    Connected Users. Along with Workflows, the Proxy API is one of two primary ways to build integrations with Paragon. The
    Proxy API accepts requests with body contents specified as application/json and supports any HTTP verb including GET,
    POST, PUT, PATCH, and DELETE.
  tags:
  - Paragon
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: paragon
    baseUri: https://proxy.useparagon.com
    description: Paragon Proxy API HTTP API.
    authentication:
      type: bearer
      token: '{{PARAGON_TOKEN}}'
    resources:
    - name: projects-projectid-sdk-proxy-integrationtype-api
      path: /projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
      operations:
      - name: proxygetrequest
        method: GET
        description: Paragon Proxy GET request to integration
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
          description: Your Paragon Project ID.
        - name: integrationType
          in: path
          type: string
          required: true
          description: The type of integration to proxy the request to (e.g., salesforce, hubspot, slack).
        - name: apiPath
          in: path
          type: string
          required: true
          description: The API path of the third-party provider to send the request to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: proxypostrequest
        method: POST
        description: Paragon Proxy POST request to integration
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
          description: Your Paragon Project ID.
        - name: integrationType
          in: path
          type: string
          required: true
          description: The type of integration to proxy the request to.
        - name: apiPath
          in: path
          type: string
          required: true
          description: The API path of the third-party provider to send the request to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: proxyputrequest
        method: PUT
        description: Paragon Proxy PUT request to integration
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
          description: Your Paragon Project ID.
        - name: integrationType
          in: path
          type: string
          required: true
          description: The type of integration to proxy the request to.
        - name: apiPath
          in: path
          type: string
          required: true
          description: The API path of the third-party provider to send the request to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: proxypatchrequest
        method: PATCH
        description: Paragon Proxy PATCH request to integration
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
          description: Your Paragon Project ID.
        - name: integrationType
          in: path
          type: string
          required: true
          description: The type of integration to proxy the request to.
        - name: apiPath
          in: path
          type: string
          required: true
          description: The API path of the third-party provider to send the request to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: proxydeleterequest
        method: DELETE
        description: Paragon Proxy DELETE request to integration
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
          description: Your Paragon Project ID.
        - name: integrationType
          in: path
          type: string
          required: true
          description: The type of integration to proxy the request to.
        - name: apiPath
          in: path
          type: string
          required: true
          description: The API path of the third-party provider to send the request to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects-projectid-sdk-proxy-custom-integrationi
      path: /projects/{projectId}/sdk/proxy/custom/{integrationId}/{apiPath}
      operations:
      - name: proxycustomgetrequest
        method: GET
        description: Paragon Proxy GET request to custom integration
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
          description: Your Paragon Project ID.
        - name: integrationId
          in: path
          type: string
          required: true
          description: The ID of the custom integration.
        - name: apiPath
          in: path
          type: string
          required: true
          description: The API path of the custom integration to send the request to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: proxycustompostrequest
        method: POST
        description: Paragon Proxy POST request to custom integration
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
          description: Your Paragon Project ID.
        - name: integrationId
          in: path
          type: string
          required: true
          description: The ID of the custom integration.
        - name: apiPath
          in: path
          type: string
          required: true
          description: The API path of the custom integration to send the request to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: paragon-rest
    description: REST adapter for Paragon Proxy API.
    resources:
    - path: /projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
      name: proxygetrequest
      operations:
      - method: GET
        name: proxygetrequest
        description: Paragon Proxy GET request to integration
        call: paragon.proxygetrequest
        with:
          projectId: rest.projectId
          integrationType: rest.integrationType
          apiPath: rest.apiPath
        outputParameters:
        - type: object
          mapping: $.
    - path: /projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
      name: proxypostrequest
      operations:
      - method: POST
        name: proxypostrequest
        description: Paragon Proxy POST request to integration
        call: paragon.proxypostrequest
        with:
          projectId: rest.projectId
          integrationType: rest.integrationType
          apiPath: rest.apiPath
        outputParameters:
        - type: object
          mapping: $.
    - path: /projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
      name: proxyputrequest
      operations:
      - method: PUT
        name: proxyputrequest
        description: Paragon Proxy PUT request to integration
        call: paragon.proxyputrequest
        with:
          projectId: rest.projectId
          integrationType: rest.integrationType
          apiPath: rest.apiPath
        outputParameters:
        - type: object
          mapping: $.
    - path: /projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
      name: proxypatchrequest
      operations:
      - method: PATCH
        name: proxypatchrequest
        description: Paragon Proxy PATCH request to integration
        call: paragon.proxypatchrequest
        with:
          projectId: rest.projectId
          integrationType: rest.integrationType
          apiPath: rest.apiPath
        outputParameters:
        - type: object
          mapping: $.
    - path: /projects/{projectId}/sdk/proxy/{integrationType}/{apiPath}
      name: proxydeleterequest
      operations:
      - method: DELETE
        name: proxydeleterequest
        description: Paragon Proxy DELETE request to integration
        call: paragon.proxydeleterequest
        with:
          projectId: rest.projectId
          integrationType: rest.integrationType
          apiPath: rest.apiPath
        outputParameters:
        - type: object
          mapping: $.
    - path: /projects/{projectId}/sdk/proxy/custom/{integrationId}/{apiPath}
      name: proxycustomgetrequest
      operations:
      - method: GET
        name: proxycustomgetrequest
        description: Paragon Proxy GET request to custom integration
        call: paragon.proxycustomgetrequest
        with:
          projectId: rest.projectId
          integrationId: rest.integrationId
          apiPath: rest.apiPath
        outputParameters:
        - type: object
          mapping: $.
    - path: /projects/{projectId}/sdk/proxy/custom/{integrationId}/{apiPath}
      name: proxycustompostrequest
      operations:
      - method: POST
        name: proxycustompostrequest
        description: Paragon Proxy POST request to custom integration
        call: paragon.proxycustompostrequest
        with:
          projectId: rest.projectId
          integrationId: rest.integrationId
          apiPath: rest.apiPath
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: paragon-mcp
    transport: http
    description: MCP adapter for Paragon Proxy API for AI agent use.
    tools:
    - name: proxygetrequest
      description: Paragon Proxy GET request to integration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: paragon.proxygetrequest
      with:
        projectId: tools.projectId
        integrationType: tools.integrationType
        apiPath: tools.apiPath
      inputParameters:
      - name: projectId
        type: string
        description: Your Paragon Project ID.
        required: true
      - name: integrationType
        type: string
        description: The type of integration to proxy the request to (e.g., salesforce, hubspot, slack).
        required: true
      - name: apiPath
        type: string
        description: The API path of the third-party provider to send the request to.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: proxypostrequest
      description: Paragon Proxy POST request to integration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: paragon.proxypostrequest
      with:
        projectId: tools.projectId
        integrationType: tools.integrationType
        apiPath: tools.apiPath
      inputParameters:
      - name: projectId
        type: string
        description: Your Paragon Project ID.
        required: true
      - name: integrationType
        type: string
        description: The type of integration to proxy the request to.
        required: true
      - name: apiPath
        type: string
        description: The API path of the third-party provider to send the request to.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: proxyputrequest
      description: Paragon Proxy PUT request to integration
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: paragon.proxyputrequest
      with:
        projectId: tools.projectId
        integrationType: tools.integrationType
        apiPath: tools.apiPath
      inputParameters:
      - name: projectId
        type: string
        description: Your Paragon Project ID.
        required: true
      - name: integrationType
        type: string
        description: The type of integration to proxy the request to.
        required: true
      - name: apiPath
        type: string
        description: The API path of the third-party provider to send the request to.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: proxypatchrequest
      description: Paragon Proxy PATCH request to integration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: paragon.proxypatchrequest
      with:
        projectId: tools.projectId
        integrationType: tools.integrationType
        apiPath: tools.apiPath
      inputParameters:
      - name: projectId
        type: string
        description: Your Paragon Project ID.
        required: true
      - name: integrationType
        type: string
        description: The type of integration to proxy the request to.
        required: true
      - name: apiPath
        type: string
        description: The API path of the third-party provider to send the request to.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: proxydeleterequest
      description: Paragon Proxy DELETE request to integration
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: paragon.proxydeleterequest
      with:
        projectId: tools.projectId
        integrationType: tools.integrationType
        apiPath: tools.apiPath
      inputParameters:
      - name: projectId
        type: string
        description: Your Paragon Project ID.
        required: true
      - name: integrationType
        type: string
        description: The type of integration to proxy the request to.
        required: true
      - name: apiPath
        type: string
        description: The API path of the third-party provider to send the request to.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: proxycustomgetrequest
      description: Paragon Proxy GET request to custom integration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: paragon.proxycustomgetrequest
      with:
        projectId: tools.projectId
        integrationId: tools.integrationId
        apiPath: tools.apiPath
      inputParameters:
      - name: projectId
        type: string
        description: Your Paragon Project ID.
        required: true
      - name: integrationId
        type: string
        description: The ID of the custom integration.
        required: true
      - name: apiPath
        type: string
        description: The API path of the custom integration to send the request to.
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: proxycustompostrequest
      description: Paragon Proxy POST request to custom integration
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: paragon.proxycustompostrequest
      with:
        projectId: tools.projectId
        integrationId: tools.integrationId
        apiPath: tools.apiPath
      inputParameters:
      - name: projectId
        type: string
        description: Your Paragon Project ID.
        required: true
      - name: integrationId
        type: string
        description: The ID of the custom integration.
        required: true
      - name: apiPath
        type: string
        description: The API path of the custom integration to send the request to.
        required: true
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    PARAGON_TOKEN: PARAGON_TOKEN