Intely Rosetta API

The Rosetta API helps you retrieve and programmatically execute pre-built data conversions, mappings, and comparisons that were created in the Intely Platform. Before accessing Rosetta routes, please make sure you have pre-configured a data mapping or comparison in the platform. In many workflows, Rosetta Mappings or Comparisons are embedded within an integration workflow which can be executed with the Connect routes.

Operations 8

GET /rosetta/comparison/{comparisonId} Get comparison #
POST /rosetta/comparison/{comparisonId}/execute Execute comparison (asynchronous) #
POST /rosetta/comparison/{comparisonId}/execute/sync Execute comparison (synchronously) #
GET /rosetta/comparisons Get comparisons #
GET /rosetta/mapping/{mappingId} Get mapping #
POST /rosetta/mapping/{mappingId}/execute Execute mapping (asynchronous) #
POST /rosetta/mapping/{mappingId}/execute/sync Execute mapping (synchronous) #
GET /rosetta/mappings Get mappings #

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/intely:intely-rosetta-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 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. See our Privacy Policy and Terms.

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

OpenAPI Specification

intely-rosetta-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Intely Rosetta API
  version: 1.2.1
  termsOfService: https://www.intely.io/terms-and-conditions/
  contact:
    name: API Support
    url: https://support.intely.io/
    email: support@intely.io
  description: 'The Intely API provides a way to programmatically access and build on the Intely Platform. Intely

    provides infrastructure to connect data and automate interoperability workflows for vendors,

    applications and provider organizations.


    Intely has provided a variety of API endpoints to call to authenticate and connect to applications,

    execute pre-built integrations and data conversions, and use our form building modules. Many

    features need to be pre-configured in our platform, you can then select the APIs for your use case

    and implement quite easily.


    All URLs referenced in the API documentation have the following base: https://api.intely.io/v1


    The API is served over HTTPS. To ensure data privacy and security, unencrypted HTTP is not supported.'
servers:
- url: https://api.intely.io/v1
- url: https://api.stg.intely.io/v1
tags:
- name: Rosetta
  description: The Rosetta API helps you retrieve and programmatically execute pre-built data conversions, mappings, and comparisons that were created in the Intely Platform. Before accessing Rosetta routes, please make sure you have pre-configured a data mapping or comparison in the platform. In many workflows, Rosetta Mappings or Comparisons are embedded within an integration workflow which can be executed with the Connect routes.
paths:
  /rosetta/comparison/{comparisonId}:
    get:
      tags:
      - Rosetta
      summary: Get comparison
      description: Returns the details of a specific comparison.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: comparisonId
        schema:
          type: string
        required: true
        description: The ID of the comparison
      responses:
        '200':
          description: Successfully returned the comparison details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RosettaComparison'
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: getRosettaComparisonByComparisonId
      x-operation-id-source: derived
  /rosetta/comparison/{comparisonId}/execute:
    post:
      tags:
      - Rosetta
      summary: Execute comparison (asynchronous)
      description: Compares data based on the provided comparison asynchronously.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: comparisonId
        schema:
          type: string
        required: true
        description: The ID of the comparison
      - in: query
        name: emailToNotify
        schema:
          type: string
        required: false
        description: The email address to notify when the comparison finishes.
      - in: query
        name: callbackUrl
        schema:
          type: string
        required: false
        description: The callback URL to send the response to once the comparison finishes.
      requestBody:
        description: The data to compare
        content:
          application/json:
            schema:
              type: object
              properties:
                inputs:
                  type: array
                  items:
                    type: object
                    properties:
                      inputId:
                        type: string
                      intelyFilePath:
                        type: string
                    required:
                    - inputId
                    - intelyFilePath
                options:
                  type: object
                  properties:
                    returnResultsAsCsv:
                      type: boolean
                      default: false
                    returnResultsAsObject:
                      type: boolean
                      default: true
                    returnRecords:
                      type: string
                      enum:
                      - all
                      - matched
                      - not matched
                    outputToIntelyStorage:
                      oneOf:
                      - type: boolean
                      - type: string
                      default: true
                    outputInResponseBody:
                      type: boolean
                      default: true
                    returnResultsCollapseExpressions:
                      type: boolean
                      default: false
                    evaluateExpressionsIndependently:
                      type: boolean
                      default: false
                  required:
                  - returnRecords
              required:
              - inputs
      responses:
        '200':
          description: Successfully scheduled a comparison to run
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  taskId:
                    type: string
                  executionId:
                    type: string
                  startTime:
                    type: string
                  createdBy:
                    type: string
        '400':
          description: Invalid comparison data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postRosettaComparisonByComparisonIdExecute
      x-operation-id-source: derived
  /rosetta/comparison/{comparisonId}/execute/sync:
    post:
      tags:
      - Rosetta
      summary: Execute comparison (synchronously)
      description: Compares data based on the provided comparison synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the comparison takes longer than 60 seconds to run.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: comparisonId
        schema:
          type: string
        required: true
        description: The ID of the comparison
      requestBody:
        description: The data to compare
        content:
          application/json:
            schema:
              type: object
              properties:
                inputs:
                  type: array
                  items:
                    type: object
                    properties:
                      inputId:
                        type: string
                      intelyFilePath:
                        type: string
                    required:
                    - inputId
                    - intelyFilePath
                options:
                  type: object
                  properties:
                    returnResultsAsCsv:
                      type: boolean
                      default: false
                    returnResultsAsObject:
                      type: boolean
                      default: true
                    returnRecords:
                      type: string
                      enum:
                      - all
                      - matched
                      - not matched
                    outputToIntelyStorage:
                      oneOf:
                      - type: boolean
                      - type: string
                      default: true
                    outputInResponseBody:
                      type: boolean
                      default: true
                    returnResultsCollapseExpressions:
                      type: boolean
                      default: false
                    evaluateExpressionsIndependently:
                      type: boolean
                      default: false
                  required:
                  - returnRecords
              required:
              - inputs
      responses:
        '200':
          description: Successfully executed a comparison
          content:
            application/json:
              schema:
                type: object
                properties:
                  output:
                    type: object
                  statistics:
                    type: object
                    properties:
                      from:
                        type: object
                        properties:
                          found:
                            type: integer
                          notFound:
                            type: integer
                          processed:
                            type: integer
                          skipped:
                            type: integer
                      to:
                        type: object
                        properties:
                          storageReads:
                            type: integer
                          cacheReads:
                            type: integer
                          skipped:
                            type: integer
        '400':
          description: Invalid comparison data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postRosettaComparisonByComparisonIdExecuteSync
      x-operation-id-source: derived
  /rosetta/comparisons:
    get:
      tags:
      - Rosetta
      summary: Get comparisons
      description: Returns all of the comparisons the user has access to. 10 results per page.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: query
        name: pageNo
        schema:
          type: number
        required: true
        description: The result set page number
      responses:
        '200':
          description: Successfully returned the comparisons the user has access to
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RosettaComparison'
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: getRosettaComparisons
      x-operation-id-source: derived
  /rosetta/mapping/{mappingId}:
    get:
      tags:
      - Rosetta
      summary: Get mapping
      description: Returns the details of a specific mapping.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: mappingId
        schema:
          type: string
        required: true
        description: The ID of the mapping
      responses:
        '200':
          description: Successfully returned the mapping details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RosettaMapping'
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: getRosettaMappingByMappingId
      x-operation-id-source: derived
  /rosetta/mapping/{mappingId}/execute:
    post:
      tags:
      - Rosetta
      summary: Execute mapping (asynchronous)
      description: Converts data based on the provided mapping asynchronously.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: mappingId
        schema:
          type: string
        required: true
        description: The ID of the mapping
      - in: query
        name: emailToNotify
        schema:
          type: string
        required: false
        description: The email address to notify when the mapping finishes.
      - in: query
        name: callbackUrl
        schema:
          type: string
        required: false
        description: The callback URL to send the response to once the mapping finishes.
      requestBody:
        description: The data to convert
        content:
          application/json:
            schema:
              type: object
              properties:
                inputs:
                  type: array
                  items:
                    type: object
                    properties:
                      inputId:
                        type: string
                      data:
                        oneOf:
                        - type: object
                        - type: string
                      intelyFilePath:
                        type: string
                      delimiter:
                        type: string
                      entryOffset:
                        type: integer
                    required:
                    - inputId
                    - data
                outputDelimiter:
                  type: string
                writeToFile:
                  type: boolean
                  default: false
                includeHeaders:
                  type: boolean
                  default: false
                enableLogging:
                  type: boolean
                  default: false
              required:
              - inputs
      responses:
        '200':
          description: Successfully scheduled a mapping to run
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  taskId:
                    type: string
                  executionId:
                    type: string
                  startTime:
                    type: string
                  createdBy:
                    type: string
        '400':
          description: Invalid mapping data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postRosettaMappingByMappingIdExecute
      x-operation-id-source: derived
  /rosetta/mapping/{mappingId}/execute/sync:
    post:
      tags:
      - Rosetta
      summary: Execute mapping (synchronous)
      description: Converts data based on the provided mapping synchronously. The endpoint will timeout after 60 seconds. Call the asynchronous execute endpoint if the mapping takes longer than 60 seconds to run.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: path
        name: mappingId
        schema:
          type: string
        required: true
        description: The ID of the mapping
      requestBody:
        description: The data to convert
        content:
          application/json:
            schema:
              type: object
              properties:
                inputs:
                  type: array
                  items:
                    type: object
                    properties:
                      inputId:
                        type: string
                      data:
                        oneOf:
                        - type: object
                        - type: string
                      intelyFilePath:
                        type: string
                      delimiter:
                        type: string
                      entryOffset:
                        type: integer
                    required:
                    - inputId
                    - data
                outputDelimiter:
                  type: string
                writeToFile:
                  type: boolean
                  default: false
                includeHeaders:
                  type: boolean
                  default: false
                enableLogging:
                  type: boolean
                  default: false
              required:
              - inputs
      responses:
        '200':
          description: Successfully executed a mapping
          content:
            application/json:
              schema:
                type: object
                properties:
                  outputs:
                    type: array
                    items:
                      type: object
                  log:
                    type: array
                    items:
                      type: object
                  issues:
                    type: object
                    properties:
                      notices:
                        type: array
                        items:
                          type: object
                      warnings:
                        type: array
                        items:
                          type: object
                      errors:
                        type: array
                        items:
                          type: object
        '400':
          description: Invalid mapping data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: postRosettaMappingByMappingIdExecuteSync
      x-operation-id-source: derived
  /rosetta/mappings:
    get:
      tags:
      - Rosetta
      summary: Get mappings
      description: Returns all of the mappings the user has access to. 10 results per page.
      parameters:
      - in: header
        name: Current-Organization-Id
        schema:
          type: string
        required: true
        description: The organization id to use
      - in: query
        name: pageNo
        schema:
          type: number
        required: true
        description: The result set page number
      responses:
        '200':
          description: Successfully returned the mappings the user has access to
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RosettaMapping'
        '400':
          description: Missing required data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearer: []
      operationId: getRosettaMappings
      x-operation-id-source: derived
components:
  schemas:
    RosettaMapping:
      type: object
      properties:
        _id:
          type: string
        organizationId:
          type: string
        isPublic:
          type: boolean
        name:
          type: string
        description:
          type: string
        isTemplate:
          type: boolean
        inputs:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              name:
                type: string
              dataTypeId:
                type: string
        customFields:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              name:
                type: string
              description:
                type: string
              dataType:
                type: string
              functionExpression:
                type: string
              functionInputReferences:
                type: array
                items:
                  type: string
              userDefinedValue:
                type: string
        outputs:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              name:
                type: string
              dataTypeId:
                type: string
              fieldMappings:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                    inputId:
                      type: string
                    customFieldId:
                      type: string
                    inputPath:
                      type: array
                      items:
                        type: object
                        properties:
                          dataTypeFieldId:
                            type: string
                          occurrenceIndex:
                            type: integer
                    outputPath:
                      type: array
                      items:
                        type: object
                        properties:
                          dataTypeFieldId:
                            type: string
                          occurrenceIndex:
                            type: integer
        modifierFirstName:
          type: string
        modifierLastName:
          type: string
    Error:
      type: object
      properties:
        message:
          type: string
        error:
          type: string
        isError:
          type: boolean
    RosettaComparison:
      type: object
      properties:
        _id:
          type: string
        organizationId:
          type: string
        name:
          type: string
        description:
          type: string
        inputs:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              name:
                type: string
              dataTypeId:
                type: string
              entryOffset:
                type: integer
        comparisons:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
              name:
                type: string
              from:
                type: object
                properties:
                  inputId:
                    type: string
                  inputPath:
                    type: array
                    items:
                      type: object
                      properties:
                        dataTypeFieldId:
                          type: string
                        occurrenceIndex:
                          type: integer
              to:
                type: object
                properties:
                  inputId:
                    type: string
                  inputPath:
                    type: array
                    items:
                      type: object
                      properties:
                        dataTypeFieldId:
                          type: string
                        occurrenceIndex:
                          type: integer
              entryComparisonType:
                type: string
                enum:
                - any
                - same
              isCaseSensitive:
                type: boolean
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
        modifiedBy:
          type: string
        deletedAt:
          type: string
          format: date-time
        deletedBy:
          type: string
  securitySchemes:
    personal_token:
      type: http
      scheme: basic
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: Privacy Policy
  url: https://www.intely.io/privacy-policy/
x-provenance:
  method: searched
  source: https://documentation.intely.io/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://documentation.intely.io/reference/delete_app-appid-instance-instanceid-webhook-webhookid.md
  - https://documentation.intely.io/reference/delete_app-appid-instance-instanceid.md
  - https://documentation.intely.io/reference/delete_storage-directory.md
  - https://documentation.intely.io/reference/delete_storage-file-delete.md
  - https://documentation.intely.io/reference/get_app-appid-instance-instanceid-webhook-webhookid.md
  - https://documentation.intely.io/reference/get_app-appid-instance-instanceid-webhooks.md
  - https://documentation.intely.io/reference/get_app-appid-instance-instanceid.md
  - https://documentation.intely.io/reference/get_app-appid-instances.md
  - https://documentation.intely.io/reference/get_app-appid.md
  - https://documentation.intely.io/reference/get_app-instances.md
  - https://documentation.intely.io/reference/get_apps.md
  - https://documentation.intely.io/reference/get_currentuser-validate.md
  - https://documentation.intely.io/reference/get_data-processor-job-jobid.md
  - https://documentation.intely.io/reference/get_data-processor-jobs.md
  - https://documentation.intely.io/reference/get_forms-api-form-all.md
  - https://documentation.intely.io/reference/get_forms-api-form-fields-formid.md
  - https://documentation.intely.io/reference/get_forms-api-form-formid.md
  - https://documentation.intely.io/reference/get_forms-api-form-submission-formid.md
  - https://documentation.intely.io/reference/get_forms-api-key-validate.md
  - https://documentation.intely.io/reference/get_forms-api-workspace-all.md
  - https://documentation.intely.io/reference/get_forms-zapier-form-fields-formid.md
  - https://documentation.intely.io/reference/get_forms-zapier-sample-submission.md
  - https://documentation.intely.io/reference/get_integration-integrationid.md
  - https://documentation.intely.io/reference/get_integrations.md
  - https://documentation.intely.io/reference/get_jwks.md
  - https://documentation.intely.io/reference/get_rosetta-comparison-comparisonid.md
  - https://documentation.intely.io/reference/get_rosetta-comparisons.md
  - https://documentation.intely.io/reference/get_rosetta-mapping-mappingid.md
  - https://documentation.intely.io/reference/get_rosetta-mappings.md
  - https://documentation.intely.io/reference/get_storage-directory-files.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-field-fieldid.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-restore.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid-webhook-webhookid.md
  - https://documentation.intely.io/reference/patch_app-appid-instance-instanceid.md
  - https://documentation.intely.io/reference/patch_storage-file-move.md
  - https://documentation.intely.io/reference/patch_storage-file-rename.md
  - https://documentation.intely.io/reference/post_app-appid-instance-instanceid-request-resourceid-actionid.md
  - https://documentation.intely.io/reference/post_app-appid-instance-instanceid-webhook.md
  - https://documentation.intely.io/reference/post_app-appid-instance.md
  - https://documentation.intely.io/reference/post_data-processor-job-jobid-execute-sync.md
  - https://documentation.intely.io/reference/post_data-processor-job-jobid-execute.md
  - https://documentation.intely.io/reference/post_forms-zapier-add.md
  - https://documentation.intely.io/reference/post_forms-zapier-submission-add.md
  - https://documentation.intely.io/reference/post_forms-zapier-update-status.md
  - https://documentation.intely.io/reference/post_integration-integrationid-execute-sync.md
  - https://documentation.intely.io/reference/post_integration-integrationid-execute.md
  - https://documentation.intely.io/reference/post_noauth-user-login-mcptoken.md
  - https://documentation.intely.io/reference/post_noauth-user-login-token.md
  - https://documentation.intely.io/reference/post_rosetta-comparison-comparisonid-execute-sync.md
  - https://documentation.intely.io/reference/post_rosetta-comparison-comparisonid-execute.md
  - https://documentation.intely.io/reference/post_rosetta-mapping-mappingid-execute-sync.md
  - https://documentation.intely.io/reference/post_rosetta-mapping-mappingid-execute.md
  - https://documentation.intely.io/reference/post_script-scriptid-execute-sync.md
  - https://documentation.intely.io/reference/post_script-scriptid-execute.md
  - https://documentation.intely.io/reference/post_storage-directory.md
  - https://documentation.intely.io/reference/post_storage-file-copy.md
  - https://documentation.intely.io/reference/post_storage-file-download.md
  - https://documentation.intely.io/reference/post_storage-file-upload-binary.md


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/intely/refs/heads/main/openapi/intely-rosetta-api-openapi.yml