Refinitiv PermID Entity Search API — Entity Search

naftiko: 1.0.0-alpha2
info:
  label: Refinitiv PermID Entity Search API — Entity Search
  description: 'Refinitiv PermID Entity Search API — Entity Search. 3 operations. Lead operation: Tag Content with Entities.
    Self-contained Naftiko capability covering one Refinitiv business surface.'
  tags:
  - Refinitiv
  - Entity Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    REFINITIV_API_KEY: REFINITIV_API_KEY
capability:
  consumes:
  - type: http
    namespace: permid-entity-search-entity-search
    baseUri: https://api-eit.refinitiv.com/permid
    description: Refinitiv PermID Entity Search API — Entity Search business capability. Self-contained, no shared references.
    resources:
    - name: calais
      path: /calais
      operations:
      - name: tagcontent
        method: POST
        description: Tag Content with Entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: x-ag-access-token
          in: header
          type: string
          description: The Open Calais API key for authentication.
          required: true
        - name: Content-Type
          in: header
          type: string
          description: The content type of the input text. Supported values include text/plain, text/html, text/xml, and text/raw.
          required: true
        - name: outputFormat
          in: header
          type: string
          description: The desired output format for the tagging results.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: lookup
      path: /lookup
      operations:
      - name: lookupentity
        method: GET
        description: Look Up Entity by PermID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: The PermID to look up.
          required: true
    - name: search
      path: /search
      operations:
      - name: searchentities
        method: GET
        description: Search Entities by Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: The search query string. Can be a name, ticker, RIC, ISIN, LEI, or PermID.
          required: true
        - name: entitytype
          in: query
          type: string
          description: Filter results by entity type.
        - name: num
          in: query
          type: integer
          description: Maximum number of results to return, default is 5.
        - name: start
          in: query
          type: integer
          description: Starting index for pagination.
    authentication:
      type: apikey
      key: x-ag-access-token
      value: '{{env.REFINITIV_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: permid-entity-search-entity-search-rest
    port: 8080
    description: REST adapter for Refinitiv PermID Entity Search API — Entity Search. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/calais
      name: calais
      description: REST surface for calais.
      operations:
      - method: POST
        name: tagcontent
        description: Tag Content with Entities
        call: permid-entity-search-entity-search.tagcontent
        with:
          x-ag-access-token: rest.x-ag-access-token
          Content-Type: rest.Content-Type
          outputFormat: rest.outputFormat
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/lookup
      name: lookup
      description: REST surface for lookup.
      operations:
      - method: GET
        name: lookupentity
        description: Look Up Entity by PermID
        call: permid-entity-search-entity-search.lookupentity
        with:
          q: rest.q
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search
      name: search
      description: REST surface for search.
      operations:
      - method: GET
        name: searchentities
        description: Search Entities by Query
        call: permid-entity-search-entity-search.searchentities
        with:
          q: rest.q
          entitytype: rest.entitytype
          num: rest.num
          start: rest.start
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: permid-entity-search-entity-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for Refinitiv PermID Entity Search API — Entity Search. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: tag-content-entities
      description: Tag Content with Entities
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: permid-entity-search-entity-search.tagcontent
      with:
        x-ag-access-token: tools.x-ag-access-token
        Content-Type: tools.Content-Type
        outputFormat: tools.outputFormat
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: look-up-entity-permid
      description: Look Up Entity by PermID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: permid-entity-search-entity-search.lookupentity
      with:
        q: tools.q
      outputParameters:
      - type: object
        mapping: $.
    - name: search-entities-query
      description: Search Entities by Query
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: permid-entity-search-entity-search.searchentities
      with:
        q: tools.q
        entitytype: tools.entitytype
        num: tools.num
        start: tools.start
      outputParameters:
      - type: object
        mapping: $.