Global headers

At times, your API will leverage certain headers for every endpoint, or the majority of them, we call these “global headers”. For convenience, generated Fern SDKs expose “global headers” to easily be updated on API calls. Take for example an API key, if we declare the API key as a global header, a user will be able to plug theirs in easily:

1
import os
2
3
class Client:
4
5
  def __init__(self, *, apiKey: str):

To configure global headers, Fern will automatically pull out headers that are used in every request, or the majority of requests, and mark them as global. In order to label additional headers as global, or to alias the names of global headers, you can leverage the x-fern-global-headers extension:

1
x-fern-global-headers:
2
  - header: custom_api_key
3
    name: api_key
4
  - header: userpool_id
5
    optional: true

yields the following client:

1
import os
2
3
class Client:
4
5
  def __init__(self, *, apiKey: str, userpoolId: typing.Optional[str])