Header

The Headers section allows you to configure authorization or other required headers for your API requests. These headers typically contain key-value pairs that are required for the API server to validate the request or specify additional information like content type.


Accessing the Headers Section

  1. Navigate to the API Call Configuration:

    • From the Tools tab in the Agent Settings section, select your API Call configuration.

    • Scroll down to the Headers (Key-Value Pairs) section.

    API Call Configuration - Header

Adding Key-Value Pairs

  1. Purpose: Key-Value pairs in the headers are used to provide necessary information for making an API request, such as authentication tokens, API keys, or content types.

  2. How to Configure:

    • Key Field: Enter the required header key. This could be a predefined key such as "Authorization", "Content-Type", or other custom headers specific to the API.

    • Value Field: Enter the corresponding value for the header key. This could be an API token, content type (e.g., "application/json"), or other necessary authentication details.

      Add new Header

  3. Example Configuration:

    • Key: "Authorization"

    • Value: "Bearer <your-auth-token>"

    • Key: "Content-Type"

    • Value: "application/json"

    Example Confuguration
  4. Adding Multiple Key-Value Pairs:

    • To add more headers, click the "Add Key-Value" button.

    • You can add multiple key-value pairs based on the requirements of the API.

    Multiple Header
  5. Deleting Key-Value Pairs:

    • If a key-value pair is no longer needed, click the red Delete button (represented by a trash icon) next to the respective key-value pair.


Headers Example:

Key
Value

Authorization

Bearer your-auth-token

Content-Type

application/json

Last updated