Skip to content

Client

amigo_sdk.AmigoClient

Amigo API client (synchronous).

config property

Access the configuration object.

organizations property

Access organization resource.

agents property

Access agent resource.

context_graphs property

Access context graph (HSM) resource.

services property

Access service resource.

conversations property

Access conversation resource.

users property

Access user resource.

__init__(*, api_key=None, api_key_id=None, user_id=None, organization_id=None, base_url=None, config=None, **httpx_kwargs)

Initialize the Amigo SDK client.

Parameters:

Name Type Description Default
api_key str | None

API key for authentication (or set AMIGO_API_KEY env var)

None
api_key_id str | None

API key ID for authentication (or set AMIGO_API_KEY_ID env var)

None
user_id str | None

User ID for API requests (or set AMIGO_USER_ID env var)

None
organization_id str | None

Organization ID for API requests (or set AMIGO_ORGANIZATION_ID env var)

None
base_url str | None

Base URL for the API (or set AMIGO_BASE_URL env var)

None
config AmigoConfig | None

Pre-configured AmigoConfig instance (overrides individual params)

None
**httpx_kwargs Any

Additional arguments passed to httpx.Client

{}

close()

Close the HTTP client.

amigo_sdk.AsyncAmigoClient

Amigo API client (asynchronous).

config property

Access the configuration object.

organizations property

Access organization resource.

agents property

Access agent resource.

context_graphs property

Access context graph (HSM) resource.

services property

Access service resource.

conversations property

Access conversation resource.

users property

Access user resource.

__init__(*, api_key=None, api_key_id=None, user_id=None, organization_id=None, base_url=None, config=None, **httpx_kwargs)

Initialize the Amigo SDK client.

Parameters:

Name Type Description Default
api_key str | None

API key for authentication (or set AMIGO_API_KEY env var)

None
api_key_id str | None

API key ID for authentication (or set AMIGO_API_KEY_ID env var)

None
user_id str | None

User ID for API requests (or set AMIGO_USER_ID env var)

None
organization_id str | None

Organization ID for API requests (or set AMIGO_ORGANIZATION_ID env var)

None
base_url str | None

Base URL for the API (or set AMIGO_BASE_URL env var)

None
config AmigoConfig | None

Pre-configured AmigoConfig instance (overrides individual params)

None
**httpx_kwargs Any

Additional arguments passed to httpx.AsyncClient

{}

aclose() async

Close the HTTP client.