get_basic_auth_credentials

Retrieve the username and password used for HTTP Basic Auth on this agent. Optionally includes a source label indicating where the credentials came from.

Parameters

include_source

boolDefaults to False

When True, the returned tuple includes a third element indicating the credential source: "provided" (set explicitly), "environment" (from SWML_BASIC_AUTH_USER / SWML_BASIC_AUTH_PASSWORD environment variables), or "generated" (auto-generated at startup).

Returns

tuple[str, str] — (username, password) when include_source is False.

tuple[str, str, str] — (username, password, source) when include_source is True.

Examples

Log credentials at startup

1 from signalwire import AgentBase
2 
3 agent = AgentBase(name="assistant", route="/assistant")
4 agent.set_prompt_text("You are a helpful assistant.")
5 user, password = agent.get_basic_auth_credentials()
6 print(f"Auth: {user}:{password}")
7 agent.serve()

Check credential source

1 from signalwire import AgentBase
2 
3 agent = AgentBase(name="assistant", route="/assistant")
4 agent.set_prompt_text("You are a helpful assistant.")
5 user, password, source = agent.get_basic_auth_credentials(include_source=True)
6 if source == "generated":
7     print(f"Auto-generated credentials: {user}:{password}")
8     print("Set SWML_BASIC_AUTH_USER and SWML_BASIC_AUTH_PASSWORD to use your own.")
9 agent.serve()