deploypod 0.1.0__py3-none-any.whl

deploypod/resources/providers.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from deploypod._http import message_result, raise_for_status
+from deploypod.types import LLMModelResponse, LLMProviderResponse, MessageResult
+
+
+class ProvidersResource:
+    def __init__(self, http: httpx.Client):
+        self._http = http
+
+    def create(self, *, provider_type: str, **kwargs: Any) -> LLMProviderResponse:
+        payload = {"provider_type": provider_type, **kwargs}
+        resp = self._http.post("/llm-providers/", json=payload)
+        raise_for_status(resp)
+        return LLMProviderResponse(**resp.json())
+
+    def list(self) -> list[LLMProviderResponse]:
+        resp = self._http.get("/llm-providers/")
+        raise_for_status(resp)
+        return [LLMProviderResponse(**p) for p in resp.json()]
+
+    def get(self, provider_id: int) -> LLMProviderResponse:
+        resp = self._http.get(f"/llm-providers/{provider_id}")
+        raise_for_status(resp)
+        return LLMProviderResponse(**resp.json())
+
+    def get_default(self) -> LLMProviderResponse:
+        resp = self._http.get("/llm-providers/default")
+        raise_for_status(resp)
+        return LLMProviderResponse(**resp.json())
+
+    def update(self, provider_id: int, **kwargs: Any) -> LLMProviderResponse:
+        resp = self._http.put(f"/llm-providers/{provider_id}", json=kwargs)
+        raise_for_status(resp)
+        return LLMProviderResponse(**resp.json())
+
+    def delete(self, provider_id: int) -> MessageResult:
+        resp = self._http.delete(f"/llm-providers/{provider_id}")
+        raise_for_status(resp)
+        return message_result(resp)
+
+    def test(self, provider_id: int) -> dict:
+        resp = self._http.post(f"/llm-providers/{provider_id}/test")
+        raise_for_status(resp)
+        return resp.json()
+
+    def list_models(self, provider_id: int) -> list[dict]:
+        resp = self._http.get(f"/llm-providers/{provider_id}/models")
+        raise_for_status(resp)
+        return resp.json()
+
+    def set_default(self, provider_id: int) -> dict:
+        resp = self._http.post(f"/llm-providers/{provider_id}/set-default")
+        raise_for_status(resp)
+        return resp.json()
+
+    def discover_vllm(self) -> dict:
+        resp = self._http.post("/llm-providers/discover-vllm")
+        raise_for_status(resp)
+        return resp.json()

deploypod/resources/skills.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from typing import Any, Dict, List
+
+import httpx
+
+from deploypod._http import message_result, raise_for_status
+from deploypod.types import MessageResult, SkillResponse
+
+
+class SkillsResource:
+    def __init__(self, http: httpx.Client):
+        self._http = http
+
+    def create(
+        self,
+        *,
+        name: str,
+        slug: str,
+        description: str | None = None,
+        invocation_mode: str = "always_on",
+        prompt_instructions: str | None = None,
+        examples: list[dict[str, Any]] | None = None,
+        allowed_tools: list[str] | None = None,
+        additional_tools: list[dict[str, Any]] | None = None,
+    ) -> SkillResponse:
+        payload: dict[str, Any] = {"name": name, "slug": slug, "invocation_mode": invocation_mode}
+        if description is not None:
+            payload["description"] = description
+        if prompt_instructions is not None:
+            payload["prompt_instructions"] = prompt_instructions
+        if examples is not None:
+            payload["examples"] = examples
+        if allowed_tools is not None:
+            payload["allowed_tools"] = allowed_tools
+        if additional_tools is not None:
+            payload["additional_tools"] = additional_tools
+        resp = self._http.post("/skills/", json=payload)
+        raise_for_status(resp)
+        return SkillResponse(**resp.json())
+
+    def list(self) -> list[SkillResponse]:
+        resp = self._http.get("/skills/")
+        raise_for_status(resp)
+        return [SkillResponse(**s) for s in resp.json()]
+
+    def get(self, skill_id: int) -> SkillResponse:
+        resp = self._http.get(f"/skills/{skill_id}")
+        raise_for_status(resp)
+        return SkillResponse(**resp.json())
+
+    def update(self, skill_id: int, **kwargs: Any) -> SkillResponse:
+        resp = self._http.put(f"/skills/{skill_id}", json=kwargs)
+        raise_for_status(resp)
+        return SkillResponse(**resp.json())
+
+    def delete(self, skill_id: int) -> MessageResult:
+        resp = self._http.delete(f"/skills/{skill_id}")
+        raise_for_status(resp)
+        return message_result(resp)
+
+    def assign_to_agent(self, skill_id: int, agent_id: int) -> MessageResult:
+        resp = self._http.post(f"/skills/{skill_id}/agents/{agent_id}")
+        raise_for_status(resp)
+        return message_result(resp)
+
+    def remove_from_agent(self, skill_id: int, agent_id: int) -> MessageResult:
+        resp = self._http.delete(f"/skills/{skill_id}/agents/{agent_id}")
+        raise_for_status(resp)
+        return message_result(resp)
+
+    def list_for_agent(self, agent_id: int) -> list[SkillResponse]:
+        resp = self._http.get(f"/skills/agents/{agent_id}/skills/")
+        raise_for_status(resp)
+        return [SkillResponse(**s) for s in resp.json()]

deploypod/resources/users.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from deploypod._http import message_result, raise_for_status
+from deploypod.types import MessageResult, UserResponse
+
+
+class UsersResource:
+    def __init__(self, http: httpx.Client):
+        self._http = http
+
+    def create(
+        self,
+        *,
+        email: str,
+        roles: list[str] | None = None,
+        username: str | None = None,
+        deployed_agent_slug: str | None = None,
+        send_password_email: bool = False,
+        app_url: str | None = None,
+    ) -> UserResponse:
+        payload: dict[str, Any] = {"email": email, "send_password_email": send_password_email}
+        if roles is not None:
+            payload["roles"] = roles
+        if username is not None:
+            payload["username"] = username
+        if deployed_agent_slug is not None:
+            payload["deployed_agent_slug"] = deployed_agent_slug
+        if app_url is not None:
+            payload["app_url"] = app_url
+        resp = self._http.post("/user/create-user", json=payload)
+        raise_for_status(resp)
+        return UserResponse(**resp.json())
+
+    def list(self) -> list[UserResponse]:
+        resp = self._http.get("/user/list")
+        raise_for_status(resp)
+        return [UserResponse(**u) for u in resp.json()]
+
+    def update_roles(self, user_id: str, roles: list[str]) -> dict:
+        resp = self._http.put(f"/user/{user_id}/roles", json={"roles": roles})
+        raise_for_status(resp)
+        return resp.json()
+
+    def delete(self, user_id: str) -> MessageResult:
+        resp = self._http.delete(f"/user/{user_id}")
+        raise_for_status(resp)
+        return message_result(resp)
+
+    def my_groups(self) -> list[dict]:
+        resp = self._http.get("/user/me/groups")
+        raise_for_status(resp)
+        return resp.json()

deploypod/types.py

@@ -0,0 +1,390 @@
+"""Response models mirroring the Deploypod API."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
+from uuid import UUID
+
+from pydantic import BaseModel, field_validator
+
+
+# ── Agents ───────────────────────────────────────────────────────────
+
+class WelcomeMessageResponse(BaseModel):
+    id: UUID
+    name: str
+    message: str
+    is_template: bool
+    template_variables: Optional[List[str]] = None
+    created_at: datetime
+    updated_at: datetime
+
+
+class WalkthroughQuestionResponse(BaseModel):
+    id: UUID
+    question_text: str
+    description: Optional[str] = None
+    display_order: Optional[int] = None
+    category: Optional[str] = None
+    is_active: Optional[bool] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+class AgentResponse(BaseModel):
+    id: int
+    uuid: UUID
+    org_id: int
+    name: str
+    group_id: Optional[int] = None
+    group_name: Optional[str] = None
+    knowledge_base_ids: List[int] = []
+    writable_kb_ids: Optional[List[int]] = None
+    llm_provider_id: Optional[int] = None
+    llm_model: Optional[str] = None
+    system_prompt_extension: Optional[str] = None
+    # JSON-Schema object the final answer is forced into (emit_result).
+    output_schema: Optional[dict[str, Any]] = None
+    autonomy_mode: str = "interactive"
+    can_use_web_search: bool = False
+    # Every web query the agent sends waits for a person's approval.
+    web_confirmation_required: bool = False
+    table_manager_enabled: bool = False
+    tts_provider: Optional[str] = None
+    tts_model: Optional[str] = None
+    tts_voice: Optional[str] = None
+    voice_id: Optional[str] = None
+    speech_speed: Optional[float] = 1.0
+    config: Optional[Dict[str, Any]] = None
+    third_party_auth_enabled: bool = False
+    welcome_messages: Optional[List[str]] = None
+    welcome_message_relationships: Optional[List[WelcomeMessageResponse]] = None
+    walkthrough_question_relationships: Optional[List[WalkthroughQuestionResponse]] = None
+    subagent_relationships: Optional[List[Dict[str, Any]]] = None
+    user_permission_level: Optional[str] = None
+    created_at: datetime
+    updated_at: datetime
+
+
+class ThirdPartyAuthResponse(BaseModel):
+    shared_secret_key: str
+    message: str
+
+
+class DeploymentResponse(BaseModel):
+    slug: Optional[str] = None
+    deployed: bool = False
+    message: Optional[str] = None
+
+
+# ── Knowledge Bases ──────────────────────────────────────────────────
+
+class KnowledgeBaseResponse(BaseModel):
+    id: int
+    org_id: int
+    name: str
+    description: Optional[str] = None
+    created_at: datetime
+    group_id: Optional[int] = None
+    group_name: Optional[str] = None
+    has_navigation: Optional[bool] = None
+    navigation_status: Optional[str] = None
+    user_permission_level: Optional[str] = None
+
+
+class KBConstraintsResponse(BaseModel):
+    max_navigation_sources: int
+    max_navigation_kbs_per_agent: int
+
+
+# ── Knowledge Sources ────────────────────────────────────────────────
+
+class KnowledgeSourceResponse(BaseModel):
+    id: int
+    name: str
+    source_identifier: str
+    status: str
+    purpose: str
+    source_type: str
+    created_at: datetime
+    last_processed_at: Optional[datetime] = None
+    error_message: Optional[str] = None
+    options: Optional[Dict[str, Any]] = None
+
+
+# ── Skills ───────────────────────────────────────────────────────────
+
+class SkillResponse(BaseModel):
+    id: int
+    uuid: str
+    organization_id: int
+    name: str
+    slug: str
+    description: Optional[str] = None
+    invocation_mode: str
+    prompt_instructions: Optional[str] = None
+    examples: Optional[Any] = None
+    allowed_tools: Optional[List[str]] = None
+    additional_tools: Optional[List[Dict[str, Any]]] = None
+    is_active: bool
+    created_by: Optional[str] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+# ── Custom Tools ─────────────────────────────────────────────────────
+
+class CustomToolResponse(BaseModel):
+    id: int
+    org_id: int
+    name: str
+    description: Optional[str] = None
+    tool_type: str
+    method: Optional[str] = None
+    url: Optional[str] = None
+    parameters: Optional[Union[List[Dict[str, Any]], Dict[str, Any]]] = None
+    headers: Optional[Union[List[Dict[str, Any]], Dict[str, Any]]] = None
+    body_template: Optional[Dict[str, Any]] = None
+    response_mapping: Optional[Dict[str, Any]] = None
+    group_id: Optional[int] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+class ToolExecutionResponse(BaseModel):
+    id: int
+    tool_id: int
+    status: str
+    response_data: Optional[Dict[str, Any]] = None
+    error_message: Optional[str] = None
+    execution_time_ms: Optional[float] = None
+    created_at: Optional[datetime] = None
+
+
+# ── MCP Servers ──────────────────────────────────────────────────────
+
+class MCPToolResponse(BaseModel):
+    id: int
+    mcp_server_id: Optional[int] = None
+    tool_name: Optional[str] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    input_schema: Optional[Dict[str, Any]] = None
+    parameters_schema: Optional[Dict[str, Any]] = None
+    is_enabled: bool = True
+    created_at: Optional[datetime] = None
+
+
+class MCPServerResponse(BaseModel):
+    id: int
+    org_id: Optional[int] = None
+    name: str
+    description: Optional[str] = None
+    endpoint_url: Optional[str] = None
+    server_type: Optional[str] = None
+    is_active: bool = True
+    health_status: Optional[str] = None
+    last_heartbeat: Optional[datetime] = None
+    group_id: Optional[int] = None
+    timeout_seconds: Optional[int] = None
+    retry_attempts: Optional[int] = None
+    tools: Optional[List[MCPToolResponse]] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+# ── LLM Providers ───────────────────────────────────────────────────
+
+class LLMProviderResponse(BaseModel):
+    id: int
+    org_id: int
+    provider_type: str
+    name: Optional[str] = None
+    api_base: Optional[str] = None
+    is_default: bool = False
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+class LLMModelResponse(BaseModel):
+    id: str
+    name: Optional[str] = None
+
+
+# ── Database Connections ─────────────────────────────────────────────
+
+class ConnectionResponse(BaseModel):
+    id: int
+    org_id: int
+    name: str
+    db_type: str
+    host: Optional[str] = None
+    port: Optional[int] = None
+    database: Optional[str] = None
+    status: Optional[str] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+class TableResponse(BaseModel):
+    id: int
+    connection_id: int
+    name: str
+    schema_info: Optional[Dict[str, Any]] = None
+    row_count: Optional[int] = None
+
+
+# ── Conversations ────────────────────────────────────────────────────
+
+class ConversationResponse(BaseModel):
+    id: UUID
+    user_id: Optional[str] = None
+    session_id: Optional[str] = None
+    org_id: int
+    agent_id: int
+    title: Optional[str] = None
+    created_at: datetime
+    message_count: int
+    agent_name: Optional[str] = None
+    username: Optional[str] = None
+    session_status: Optional[str] = None
+    session_display_status: Optional[str] = None
+    last_activity_at: Optional[datetime] = None
+    session_expires_at: Optional[datetime] = None
+
+
+class MessageResponse(BaseModel):
+    id: int
+    conversation_id: UUID
+    sender: str
+    content: str
+    timestamp: datetime
+    response_metadata: Optional[Dict] = None
+    iterations: Optional[List[Dict]] = None
+
+
+class ConversationDetailResponse(BaseModel):
+    conversation: ConversationResponse
+    messages: List[MessageResponse]
+
+
+# ── Users ────────────────────────────────────────────────────────────
+
+class UserGroupMembershipInfo(BaseModel):
+    group_id: int
+    group_name: str
+    permission_level: str
+
+
+class UserResponse(BaseModel):
+    id: str
+    username: str
+    email: str
+    org_id: int
+    roles: Optional[List[str]] = None
+    created_at: Optional[datetime] = None
+    group_memberships: Optional[List[UserGroupMembershipInfo]] = None
+    # Only on create-user: whether the login email went out, and the
+    # temporary password, returned this once.
+    email_sent: Optional[bool] = None
+    email_error: Optional[str] = None
+    temp_password: Optional[str] = None
+
+
+# ── Groups ───────────────────────────────────────────────────────────
+
+class GroupResponse(BaseModel):
+    id: int
+    uuid: Optional[UUID] = None
+    org_id: int
+    name: str
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+    member_count: Optional[int] = None
+
+
+class GroupMemberResponse(BaseModel):
+    user_id: str
+    username: Optional[str] = None
+    email: Optional[str] = None
+    permission_level: str
+
+
+# ── Organization ─────────────────────────────────────────────────────
+
+class LicenseInfoResponse(BaseModel):
+    tier: str
+    status: str
+    limits: Dict[str, Any]
+    current_usage: Dict[str, Any]
+    expires_at: Optional[str] = None
+    features: Dict[str, Any]
+
+
+# ── Async Tasks ──────────────────────────────────────────────────────
+
+class AsyncTaskResponse(BaseModel):
+    id: int
+    agent_id: int
+    name: str
+    prompt: str
+    schedule_cron: str
+    timeout_seconds: Optional[int] = None
+    enabled: bool = True
+    next_run_at: Optional[datetime] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+class AsyncRunResponse(BaseModel):
+    id: int
+    task_id: int
+    status: str
+    result_data: Optional[Dict[str, Any]] = None
+    result_summary: Optional[str] = None
+    error_message: Optional[str] = None
+    execution_time_ms: Optional[float] = None
+    started_at: Optional[datetime] = None
+    completed_at: Optional[datetime] = None
+
+    @field_validator("result_data", mode="before")
+    @classmethod
+    def _parse_result_data(cls, v: Any) -> Any:
+        if isinstance(v, str):
+            import json
+            return json.loads(v)
+        return v
+
+
+# ── Jobs ─────────────────────────────────────────────────────────────
+
+class JobResponse(BaseModel):
+    id: int
+    status: str
+    job_type: Optional[str] = None
+    progress: Optional[float] = None
+    error_message: Optional[str] = None
+    created_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+
+
+# ── Pruning ──────────────────────────────────────────────────────────
+
+class TestPruningResponse(BaseModel):
+    total_tables: int
+    total_tools: int
+    selected_tables: list[str]
+    selected_tools: list[str]
+    duration_ms: int
+    source_pruning_active: bool
+    tool_pruning_active: bool
+    source_threshold: int
+    tool_threshold: int
+
+
+# ── Generic ──────────────────────────────────────────────────────────
+
+class MessageResult(BaseModel):
+    """Generic {message: ...} response from delete/assign endpoints."""
+    message: str

deploypod-0.1.0.dist-info/METADATA

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: deploypod
+Version: 0.1.0
+Summary: Python client for the Deploypod API: run AI agents, manage their tools and knowledge bases.
+Author: Deploypod
+License-Expression: MIT
+Project-URL: Homepage, https://deploypod.ai
+Project-URL: Documentation, https://docs.deploypod.ai/en/gelistirici/sdk-ve-widget/
+Keywords: deploypod,ai,agents,llm,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-httpx>=0.30.0; extra == "dev"
+Dynamic: license-file
+
+# Deploypod Python SDK
+
+The Python client for the [Deploypod](https://deploypod.ai) API. Run your AI
+agents from code, and manage their instructions, tools and knowledge bases.
+
+```bash
+pip install deploypod
+```
+
+Python 3.9 or newer.
+
+## Sign in
+
+Ask your Deploypod administrator for an application (`app_id`, `app_secret`)
+and your organization's number. The client gets the access token itself and
+renews it before it expires.
+
+```python
+from deploypod import DeploypodClient
+
+client = DeploypodClient(
+    org_id="42",
+    app_id="YOUR_APP_ID",
+    app_secret="YOUR_APP_SECRET",
+)
+```
+
+Keep `app_secret` out of your code: read it from the environment.
+
+```bash
+export DEPLOYPOD_ORG_ID=42
+export DEPLOYPOD_APP_ID=...
+export DEPLOYPOD_APP_SECRET=...
+```
+
+```python
+from deploypod import get_client_from_env
+
+client = get_client_from_env()
+```
+
+Already have an access token? Pass `token="..."` instead of the app
+credentials. For an on-premises installation, pass
+`base_url="https://your-host/api"`.
+
+## Run an agent
+
+```python
+for agent in client.agents.list():
+    print(agent.uuid, agent.name)
+
+result = client.agents.run(
+    "AGENT_UUID",
+    "How many days of annual leave do I have?",
+    run_exploration=True,
+    timeout=300,
+)
+print(result["result_summary"])
+```
+
+`run` waits for the answer. Other request fields go in as keyword arguments,
+for example `output_schema={...}` to get the answer as JSON in
+`result["final_emit"]`. Requests through `deploypod.ai` are cut after 100
+seconds; for longer work (web research, presentations) use the WebSocket API.
+
+## Errors
+
+Every error is a `deploypod.DeploypodError` with `status_code` and `detail`.
+Subclasses: `AuthenticationError` (401/403), `NotFoundError`,
+`ValidationError`, `ConflictError`, `LicenseError`, `ServerError`.
+
+## Documentation
+
+Full guides, the REST and WebSocket APIs, and the chat widget:
+<https://docs.deploypod.ai/en/>
+
+## License
+
+MIT