@qtsurfer/api-client
    Preparing search index...

    Function authenticate

    • Exchange API key for a short-lived JWT Exchanges a long-lived API key for a short-lived JWT used by every other endpoint. This is the only endpoint that accepts an API key directly — callers should obtain a JWT here, then send it as Authorization: Bearer <token> to all other operations.

      The returned JWT carries the caller's subscription tier as a claim and expires after expires_in seconds. Callers should refresh the token before expiry (or on a 401 response) by calling this endpoint again.

      Type Parameters

      • ThrowOnError extends boolean = false

      Parameters

      Returns RequestResult<AuthTokenResponse, unknown, ThrowOnError>