enterprise_ai.client

Source: sdks/python/src/enterprise_ai/client.py. Back to the Python SDK reference index.

note

This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.

Class EnterpriseAI

Synchronous client.

_ClientBase

Attributes:

Name	Type	Required	Description
a2a	A2AClient	yes	Agent to agent messaging with a versioned envelope.
agents	AgentsClient	yes	/v1/agents.
applications	ApplicationsClient	yes	/v1/applications.
approvals	ApprovalsClient	yes	/v1/approvals.
audit	AuditClient	yes	/v1/audit.
authz	AuthzClient	yes	/v1/authz/check (OpenFGA, relation checks) and /v1/policies/evaluate (OPA, explained decision).
break_glass	BreakGlassClient	yes	/v1/break-glass: audited emergency grants with a short lifetime.
business_units	BusinessUnitsClient	yes	/v1/business-units: business units of an organization, optionally nested (tenant hierarchy).
channels	ChannelsClient	yes	/v1/channels.
compliance	ComplianceClient	yes	/v1/compliance/instances.
config		yes	Resolved connection settings (ClientConfig) shared by every sub-client.
connectors	ConnectorsClient	yes	/v1/connectors, /v1/credentials/broker/lease, /v1/webhooks.
context	ContextClient	yes	/v1/context/plan: server side budget and compression plan.
contracts	ContractsClient	yes	/v1/contracts: the server side copy of the schemas and remote validation.
delegations	DelegationsClient	yes	/v1/delegations: scoped, time bound delegations between principals.
dlp	DlpClient	yes	/v1/dlp.
encryption	EncryptionClient	yes	/v1/encryption.
evaluation	EvaluationClient	yes	/v1/evaluations and /v1/redteam.
evidence	EvidenceClient	yes	/v1/evidence.
execution_context	ExecutionContextClient	yes	/v1/context: signed execution contexts and their signing keys.
file_security	FileSecurityClient	yes	/v1/file-security: engine status, tenant policy, explicit scans, rescans, sample purge and stats.
finops	FinopsClient	yes	/v1/finops.
gateway	GatewayClient	yes	/v1/gateway/*.
governance	GovernanceClient	yes	/v1/governance/registry: agents, models, tools, owners and risk in one view.
identity	IdentityClient	yes	/v1/me, /v1/members, /v1/api-keys, /v1/service-identities, /v1/authz, /v1/secrets, /v1/identity/quota-profiles and /v1/identity/group-mappings.
incidents	IncidentsClient	yes	/v1/incidents and response actions (suspend agent/model/provider, rotate key).
isolation	IsolationClient	yes	/v1/llm/isolation.
license	LicenseClient	yes	/v1/license.
llm	LlmClient	yes	One entry point over /v1/gateway/chat/completions, /v1/gateway/embeddings and /v1/multimodal/vision; every call keeps the gateway checks (effort precheck, policy, DLP, quotas).
llm_management	LlmManagementClient	yes	/v1/llm/projects (LiteLLM teams) and /v1/llm/projects/{project_id}/keys (LiteLLM virtual keys).
mandates	MandatesClient	yes	/v1/mandates: standing mandates of autonomous agents (scheduled work).
manifests	ManifestsClient	yes	/v1/manifests: apply any manifest kind and export registry entries as manifests.
marketplace	MarketplaceClient	yes	/v1/marketplace.
mcp	McpClient	yes	/v1/mcp.
mcp_runtime	McpRuntimeClient	yes	/v1/projects/{project_id}/mcp/instances, /v1/projects/{project_id}/mcp/policy, /v1/mcp/runtime/jwks.
memory	MemoryClient	yes	/v1/memory.
models	ModelsClient	yes	/v1/models, /v1/llm/categories, /v1/litellm.
multimodal	MultimodalClient	yes	/v1/media and /v1/multimodal/*; modality helpers are attributes.
navin_library	NavinLibraryClient	yes	/v1/navin-library and /v1/projects/{id}/navin-library, /v1/projects/{id}/rules.
organizations	OrganizationsClient	yes	/v1/organizations: organizations of the tenant (tenant hierarchy, ADR-0156).
platform_manager	PlatformManagerClient	yes	/v1/platform-manager.
plugins	PluginsClient	yes	/v1/plugins.
policies	PoliciesClient	yes	/v1/policies.
privacy	PrivacyClient	yes	/v1/privacy, /v1/retention, /v1/lineage.
projects	ProjectsClient	yes	/v1/projects and project environments.
prompts	PromptsClient	yes	/v1/prompts.
providers	ProvidersClient	yes	/v1/providers and /v1/adapters.
quotas	QuotasClient	yes	/v1/quotas.
rag	RagClient	yes	/v1/knowledge-bases.
rag_agent	RagAgentClient	yes	/v1/rag-agent/instances.
realtime	RealtimeClient	yes	/v1/realtime.
risk	RiskClient	yes	/v1/risk: assessments, controls, exceptions, evidence.
routes	RoutesClient	yes	/v1/routes.
runs	RunsClient	yes	/v1/runs, /v1/checkpoints, /v1/heartbeats.
sandbox	SandboxClient	yes	/v1/sandbox/executions.
schedules	SchedulesClient	yes	/v1/schedules.
security	SecurityClient	yes	/v1/security/posture and /v1/security/settings.
sessions	SessionsClient	yes	/v1/sessions and their messages.
skills	SkillsClient	yes	/v1/skills.
soc	SocClient	yes	/v1/soc.
storage	StorageClient	yes	/v1/storage.
system	SystemClient	yes	Platform level read endpoints (no tenant data).
telemetry	TelemetryClient	yes	/v1/telemetry.
telephony	TelephonyClient	yes	/v1/telephony: settings, quotas, PBX pools, SIP trunks, numbers, extensions, routing, IVR, queues, agents, AI voice agents, conferences, publication, calls, recordings, voicemail, prompts, fraud and infrastructure.
tenants	TenantsClient	yes	/v1/tenants.
tokenization	TokenizationClient	yes	/v1/tokenization (policy checked and audited server side).
tools	ToolsClient	yes	/v1/tools: registry and Tool Gateway (scopes, policy, DLP, approval, cost).
triggers	TriggersClient	yes	/v1/triggers and /v1/events/publish (NATS subjects).

Constructor EnterpriseAI

EnterpriseAI(base_url: str | None = None, http_client: httpx.Client | None = None, transport: httpx.BaseTransport | None = None, **kwargs: Any) -> None

Build the configuration from the arguments and the EAI_* variables, then wire every sub-client on a SyncTransport.

Name	Type	Default	Required	Description
base_url	str | None	None	no	Address of the API; None falls back to EAI_BASE_URL, then to a local address.
http_client	httpx.Client | None	None	no	Existing httpx.Client to send the requests; by default one is created from the configuration.
transport	httpx.BaseTransport | None	None	no	Transport shared by the sub-clients of one client.
**kwargs	Any		no	Fields of ClientConfig (api_key, token, tenant, locale, timeout, retries...); any other key is passed to httpx.Client.

EnterpriseAI.close

close() -> None

Close the transport and its HTTP connections; also called at the end of a with block.

This element takes no parameter.

Returns: None.

Class AsyncEnterpriseAI

Asynchronous client: every sub-client method returns an awaitable.

_ClientBase

Attributes:

Name	Type	Required	Description
a2a	A2AClient	yes	Agent to agent messaging with a versioned envelope.
agents	AgentsClient	yes	/v1/agents.
applications	ApplicationsClient	yes	/v1/applications.
approvals	ApprovalsClient	yes	/v1/approvals.
audit	AuditClient	yes	/v1/audit.
authz	AuthzClient	yes	/v1/authz/check (OpenFGA, relation checks) and /v1/policies/evaluate (OPA, explained decision).
break_glass	BreakGlassClient	yes	/v1/break-glass: audited emergency grants with a short lifetime.
business_units	BusinessUnitsClient	yes	/v1/business-units: business units of an organization, optionally nested (tenant hierarchy).
channels	ChannelsClient	yes	/v1/channels.
compliance	ComplianceClient	yes	/v1/compliance/instances.
config		yes	Resolved connection settings (ClientConfig) shared by every sub-client.
connectors	ConnectorsClient	yes	/v1/connectors, /v1/credentials/broker/lease, /v1/webhooks.
context	ContextClient	yes	/v1/context/plan: server side budget and compression plan.
contracts	ContractsClient	yes	/v1/contracts: the server side copy of the schemas and remote validation.
delegations	DelegationsClient	yes	/v1/delegations: scoped, time bound delegations between principals.
dlp	DlpClient	yes	/v1/dlp.
encryption	EncryptionClient	yes	/v1/encryption.
evaluation	EvaluationClient	yes	/v1/evaluations and /v1/redteam.
evidence	EvidenceClient	yes	/v1/evidence.
execution_context	ExecutionContextClient	yes	/v1/context: signed execution contexts and their signing keys.
file_security	FileSecurityClient	yes	/v1/file-security: engine status, tenant policy, explicit scans, rescans, sample purge and stats.
finops	FinopsClient	yes	/v1/finops.
gateway	AsyncGatewayClient	yes	Async gateway: the effort pre-check awaits the registry lookup.
governance	GovernanceClient	yes	/v1/governance/registry: agents, models, tools, owners and risk in one view.
identity	IdentityClient	yes	/v1/me, /v1/members, /v1/api-keys, /v1/service-identities, /v1/authz, /v1/secrets, /v1/identity/quota-profiles and /v1/identity/group-mappings.
incidents	IncidentsClient	yes	/v1/incidents and response actions (suspend agent/model/provider, rotate key).
isolation	IsolationClient	yes	/v1/llm/isolation.
license	LicenseClient	yes	/v1/license.
llm	LlmClient	yes	One entry point over /v1/gateway/chat/completions, /v1/gateway/embeddings and /v1/multimodal/vision; every call keeps the gateway checks (effort precheck, policy, DLP, quotas).
llm_management	LlmManagementClient	yes	/v1/llm/projects (LiteLLM teams) and /v1/llm/projects/{project_id}/keys (LiteLLM virtual keys).
mandates	MandatesClient	yes	/v1/mandates: standing mandates of autonomous agents (scheduled work).
manifests	ManifestsClient	yes	/v1/manifests: apply any manifest kind and export registry entries as manifests.
marketplace	MarketplaceClient	yes	/v1/marketplace.
mcp	McpClient	yes	/v1/mcp.
mcp_runtime	McpRuntimeClient	yes	/v1/projects/{project_id}/mcp/instances, /v1/projects/{project_id}/mcp/policy, /v1/mcp/runtime/jwks.
memory	MemoryClient	yes	/v1/memory.
models	ModelsClient	yes	/v1/models, /v1/llm/categories, /v1/litellm.
multimodal	MultimodalClient	yes	/v1/media and /v1/multimodal/*; modality helpers are attributes.
navin_library	NavinLibraryClient	yes	/v1/navin-library and /v1/projects/{id}/navin-library, /v1/projects/{id}/rules.
organizations	OrganizationsClient	yes	/v1/organizations: organizations of the tenant (tenant hierarchy, ADR-0156).
platform_manager	PlatformManagerClient	yes	/v1/platform-manager.
plugins	PluginsClient	yes	/v1/plugins.
policies	PoliciesClient	yes	/v1/policies.
privacy	PrivacyClient	yes	/v1/privacy, /v1/retention, /v1/lineage.
projects	ProjectsClient	yes	/v1/projects and project environments.
prompts	PromptsClient	yes	/v1/prompts.
providers	ProvidersClient	yes	/v1/providers and /v1/adapters.
quotas	QuotasClient	yes	/v1/quotas.
rag	RagClient	yes	/v1/knowledge-bases.
rag_agent	RagAgentClient	yes	/v1/rag-agent/instances.
realtime	RealtimeClient	yes	/v1/realtime.
risk	RiskClient	yes	/v1/risk: assessments, controls, exceptions, evidence.
routes	RoutesClient	yes	/v1/routes.
runs	RunsClient	yes	/v1/runs, /v1/checkpoints, /v1/heartbeats.
sandbox	SandboxClient	yes	/v1/sandbox/executions.
schedules	SchedulesClient	yes	/v1/schedules.
security	SecurityClient	yes	/v1/security/posture and /v1/security/settings.
sessions	SessionsClient	yes	/v1/sessions and their messages.
skills	SkillsClient	yes	/v1/skills.
soc	SocClient	yes	/v1/soc.
storage	StorageClient	yes	/v1/storage.
system	SystemClient	yes	Platform level read endpoints (no tenant data).
telemetry	TelemetryClient	yes	/v1/telemetry.
telephony	TelephonyClient	yes	/v1/telephony: settings, quotas, PBX pools, SIP trunks, numbers, extensions, routing, IVR, queues, agents, AI voice agents, conferences, publication, calls, recordings, voicemail, prompts, fraud and infrastructure.
tenants	TenantsClient	yes	/v1/tenants.
tokenization	TokenizationClient	yes	/v1/tokenization (policy checked and audited server side).
tools	ToolsClient	yes	/v1/tools: registry and Tool Gateway (scopes, policy, DLP, approval, cost).
triggers	TriggersClient	yes	/v1/triggers and /v1/events/publish (NATS subjects).

Constructor AsyncEnterpriseAI

AsyncEnterpriseAI(base_url: str | None = None, http_client: httpx.AsyncClient | None = None, transport: httpx.AsyncBaseTransport | None = None, **kwargs: Any) -> None

Build the configuration from the arguments and the EAI_* variables, then wire every sub-client on an AsyncTransport.

Name	Type	Default	Required	Description
base_url	str | None	None	no	Address of the API; None falls back to EAI_BASE_URL, then to a local address.
http_client	httpx.AsyncClient | None	None	no	Existing httpx.AsyncClient to send the requests; by default one is created from the configuration.
transport	httpx.AsyncBaseTransport | None	None	no	Transport shared by the sub-clients of one client.
**kwargs	Any		no	Fields of ClientConfig (api_key, token, tenant, locale, timeout, retries...); any other key is passed to httpx.AsyncClient.

AsyncEnterpriseAI.close

async close() -> None

Close the transport and its HTTP connections (a coroutine); also called by async with.

This element takes no parameter.

Returns: None.