API Types Reference

​

Overview

This reference documents all the public types available in the Wacht Rust SDK API modules. Types are organized by their respective API modules.

​

Users API Types

​

Response Types

• UserListResponse - Response containing paginated list of users
• UserDetailsResponse - Detailed user information with organizations and workspaces
• InvitationListResponse - Response containing user invitations
• WaitlistResponse - Response containing waitlist users

​

Request Types

• ListUsersOptions - Query options for listing users
• UserInvitation - User invitation details structure

​

Organizations API Types

​

Response Types

• OrganizationListResponse - Response containing paginated list of organizations
• OrganizationRoleListResponse - Response containing organization roles

​

Request Types

• ListOrganizationsOptions - Query options for listing organizations

​

Workspaces API Types

​

Response Types

• WorkspaceListResponse - Response containing paginated list of workspaces
• WorkspaceRoleListResponse - Response containing workspace roles

​

Request Types

• ListWorkspacesOptions - Query options for listing workspaces

​

Agents API Types

​

Response Types

• AgentListResponse - Response containing paginated list of AI agents

​

Request Types

• ListAgentsOptions - Query options for listing agents

​

Workflows API Types

​

Response Types

• WorkflowListResponse - Response containing paginated list of workflows

​

Request Types

• ListWorkflowsOptions - Query options for listing workflows

​

Knowledge Bases API Types

​

Response Types

• KnowledgeBaseListResponse - Response containing paginated list of knowledge bases
• DocumentListResponse - Response containing list of documents

​

Request Types

• ListKnowledgeBasesOptions - Query options for listing knowledge bases
• KnowledgeBaseSearchOptions - Options for searching knowledge bases

​

Tools API Types

​

Response Types

• ToolListResponse - Response containing paginated list of AI tools

​

Request Types

• ListToolsOptions - Query options for listing tools

​

Analytics API Types

​

Response Types

• RecentSignupsResponse - Response containing recent signups data

​

Request Types

• AnalyticsStatsOptions - Query options for analytics statistics

​

Settings API Types

​

Response Types

• DeploymentSettingsResponse - Complete deployment settings structure
• JwtTemplateListResponse - Response containing JWT templates
• ImageUploadResponse - Response after uploading an image

​

Health API Types

​

Response Types

• HealthStatus - Overall health status of the API
• ServiceHealth - Health status of individual service

​

Common Patterns

Most API modules follow consistent patterns:

1. List Responses - Include data array and has_more boolean for pagination
2. Options Types - Provide filtering and pagination parameters
3. Request/Response Separation - Clear distinction between input and output types
4. Nested Resources - Proper handling of resources within resources (e.g., documents in knowledge bases)

​

Type Categories

​

Response Types

Response types are returned by API methods and typically include:

• Data arrays for list operations
• Pagination indicators
• Metadata about the response

​

Request Types

Request types are used as input parameters and typically include:

• Query options (pagination, filtering, search)
• Creation payloads
• Update payloads

​

Option Types

Option types provide query parameters for list operations:

• page and per_page for pagination
• search for text searching
• Filter fields like is_active, organization_id, etc.

​

See Also

• API Modules - Overview of all API modules
• Error Handling - How to handle API errors
• Authentication - Authentication with the API