Skip to main content
Version: 1.1.x

Transform API Call Processor

Overview​

The Transform API Call processor modifies API requests or responses based on predefined transformation rules. It allows setting, deleting, and obfuscating specific request parameters.

Transform API Call

Input and Output​

This processor operates within the request or response streams, transforming the request or response according to the provided rules.

  • Input Stream: Request/Response – The processor intercepts and transforms the request or response based on the transformation rules defined (e.g., setting values, obfuscating fields, or deleting certain data).

  • Output Stream: Request/Response – After applying the transformations, the modified request is sent to the output stream and can continue further along the flow.

Parameters​

Each parameter is defined as a key-value pair inside the parameters section.

set​

Type: map_of_strings
Required: False
Defines key-value pairs for the set operation. The key is the JSON path to the field to be modified, and the value is the new assigned value.

Example:

- key: set
  value:
    $.request.path: '/v1/messages'
    $.request.host: 'api.anthropic.com'
    $.request.parsed_query.limit[0]: '20'
    $.request.headers['x-api-key']: $ANTHROPIC_API_KEY

obfuscate​

Type: list_of_strings
Required: False
Default: []
Defines a list of fields to be obfuscated in the request. Each value is the JSON path to the field to be masked.

Example:

- key: obfuscate
  value:
  - $.request.headers['user-agent']

delete​

Type: list_of_strings
Required: False
Default: []
Defines a list of fields to be removed from the request. Each value is the JSON path to the field to be deleted.

Example:

- key: delete
  value:
  - $.request.headers.Authorization
  - $.request.headers['openai-organization']
  - $.request.headers['x-stainless-1']
  - $.request.parsed_query.resource_id

Best Practices​

  • Use set for modifying specific request values dynamically.
  • Apply delete to remove sensitive or unnecessary request headers or parameters.
  • Use obfuscate to mask sensitive information without removing it entirely.

Transform API Call Processor Template​

  TransformAPICall:
    processor: TransformAPICall
    parameters:
      - key: set
        value:
          $.request.path: '/v1/messages'
          $.request.host: 'api.anthropic.com'
          $.request.parsed_query.limit[0]: '20'
          $.request.headers['x-api-key']: $ANTHROPIC_API_KEY
      - key: delete
        value:
          - $.request.headers.Authorization
          - $.request.headers['openai-organization']
          - $.request.headers['x-stainless-1']
          - $.request.parsed_query.resource_id
      - key: obfuscate
        value:
          - $.request.headers['user-agent']

For more details on configuring flows, visit the Lunar.dev Flows Documentation.