Skip to main content

Module models

Module models 

Source
Expand description

Data models for API requests and responses Data models for Composio API

This module contains all request and response models for the Composio Tool Router API, as well as enums for various API types.

§Organization

  • [request] - Request models for API calls
  • [response] - Response models from API calls
  • [enums] - Enums for meta tool slugs, tag types, and auth schemes

§Examples

use composio_sdk::models::{SessionConfig, ToolkitFilter, MetaToolSlug};

// Create a session configuration
let config = SessionConfig {
    user_id: "user_123".to_string(),
    toolkits: Some(ToolkitFilter::Enable(vec!["github".to_string()])),
    auth_configs: None,
    connected_accounts: None,
    manage_connections: Some(true),
    tools: None,
    tags: None,
    workbench: None,
};

Re-exports§

pub use base::Resource;
pub use base::BaseResource;
pub use base::TelemetryContext;
pub use base::Environment;
pub use auth_configs::AuthConfigListParams;
pub use auth_configs::AuthConfigListResponse;
pub use auth_configs::AuthConfigInfo;
pub use auth_configs::AuthConfigCreateParams;
pub use auth_configs::AuthConfigOptions;
pub use auth_configs::AuthConfigCreateResponse;
pub use auth_configs::AuthConfig;
pub use auth_configs::AuthConfigRetrieveResponse;
pub use auth_configs::AuthConfigUpdateParams;
pub use auth_configs::DefaultCredentials;
pub use auth_configs::AuthConfigUpdateResponse;
pub use auth_configs::AuthConfigStatus;
pub use auth_configs::AuthConfigDeleteResponse;
pub use auth_configs::AuthConfigStatusUpdateResponse;
pub use cli::CliSessionStatus;
pub use cli::CliLinkedAccount;
pub use cli::CliGetSessionParams;
pub use cli::CliCreateSessionResponse;
pub use cli::CliGetSessionResponse;
pub use connected_accounts::ConnectionRequest;
pub use connected_accounts::ConnectionStatus;
pub use connected_accounts::ConnectionError;
pub use connected_accounts::AuthScheme;
pub use connected_accounts::ConnectionState;
pub use connected_accounts::AuthSchemeHelper;
pub use connected_accounts::AUTH_SCHEME;
pub use connected_accounts::InitiateConnectionParams;
pub use connected_accounts::LinkConnectionParams;
pub use connected_accounts::ConnectedAccountListParams;
pub use connected_accounts::ConnectedAccountInfo;
pub use connected_accounts::ConnectedAccountListResponse;
pub use connected_accounts::ConnectedAccountRefreshParams;
pub use connected_accounts::ConnectedAccountRefreshResponse;
pub use connected_accounts::ConnectedAccountUpdateStatusParams;
pub use connected_accounts::ConnectedAccountDeleteResponse;
pub use link::ConnectedAccountLinkCreateParams;
pub use link::ConnectedAccountLinkCreateResponse;
pub use connected_accounts::ConnectedAccountUpdateStatusResponse;
pub use connected_accounts::DEFAULT_WAIT_TIMEOUT;
pub use tools::ToolExecutionResponse;
pub use tools::ToolExecuteParams as ToolsExecuteParams;
pub use tools::CustomAuthParams as ToolsCustomAuthParams;
pub use tools::CustomConnectionData as ToolsCustomConnectionData;
pub use tools::ToolListParams;
pub use tools::ToolInfo;
pub use tools::ToolkitRef;
pub use tools::ToolListResponse;
pub use tools::ToolRetrieveEnumResponse;
pub use tools::ToolProxyParams;
pub use tools::HttpMethod;
pub use tools::ProxyParameter;
pub use tools::ParameterLocation;
pub use tools::ToolProxyResponse;
pub use tools::ToolInputGenerationParams;
pub use tools::ToolInputGenerationResponse;
pub use tools::CustomToolDefinition;
pub use tools::CustomToolExecutionRequest;
pub use custom_tools::CustomTool;
pub use custom_tools::CustomToolsRegistry;
pub use custom_tools::ExecuteRequestFn;
pub use custom_tools::CustomToolExecutor;
pub use modifiers::ToolExecuteParams;
pub use modifiers::CustomAuthParams;
pub use modifiers::CustomConnectionData;
pub use modifiers::ModifierType;
pub use modifiers::BeforeExecute;
pub use modifiers::AfterExecute;
pub use modifiers::SchemaModifier;
pub use modifiers::BeforeExecuteMeta;
pub use modifiers::AfterExecuteMeta;
pub use modifiers::Modifier;
pub use modifiers::Modifiers;
pub use modifiers::apply_before_execute_modifiers;
pub use modifiers::apply_after_execute_modifiers;
pub use modifiers::apply_schema_modifiers;
pub use modifiers::apply_before_execute_meta_modifiers;
pub use modifiers::apply_after_execute_meta_modifiers;
pub use telemetry::TelemetryData;
pub use telemetry::ErrorData;
pub use telemetry::SourceData;
pub use telemetry::Metadata;
pub use telemetry::EventType;
pub use telemetry::Event;
pub use telemetry::push_event;
pub use telemetry::create_event;
pub use files::FileUploadable;
pub use files::FileDownloadable;
pub use files::FileHelper;
pub use files::FileListParams;
pub use files::FileListItem;
pub use files::FileListResponse;
pub use files::FileCreatePresignedUrlParams;
pub use files::FileCreatePresignedUrlMetadata;
pub use files::FileStorageBackend;
pub use files::FileUploadResponse;
pub use files::FileCreatePresignedUrlResponse;
pub use internal::Internal;
pub use internal::SDKRealtimeCredentialsResponse;
pub use migration::MigrationResourceType;
pub use migration::MigrationGetNanoIdParams;
pub use migration::MigrationGetNanoIdResponse;
pub use mcp::MCPToolkitConfig;
pub use mcp::MCPServerInstance;
pub use mcp::MCPItem;
pub use mcp::MCPListResponse;
pub use mcp::MCPCreateResponse;
pub use mcp::MCPUpdateResponse;
pub use mcp::MCPDeleteResponse;
pub use mcp::MCPGenerateUrlResponse;
pub use mcp::MCPRetrieveAppResponse;
pub use mcp::MCPCustomCreateResponse;
pub use mcp::MCPCreateParams;
pub use mcp::MCPUpdateParams;
pub use mcp::MCPListParams;
pub use mcp::MCPGenerateUrlParams;
pub use mcp::MCPCustomCreateParams;
pub use mcp::MCPRetrieveAppParams;
pub use project::ProjectLogVisibilitySetting;
pub use project::ProjectConfigResponse;
pub use project::ProjectConfigUpdateParams;
pub use enums::MetaToolSlug;
pub use enums::TagType;
pub use versioning::ToolkitVersion;
pub use versioning::ToolkitVersions;
pub use versioning::ToolkitVersionParam;
pub use versioning::TOOLKIT_LATEST_VERSION;
pub use request::SessionConfig;
pub use request::ManageConnectionsConfig;
pub use request::ToolkitFilter;
pub use request::ToolsConfig;
pub use request::ToolFilter;
pub use request::TagsConfig;
pub use request::WorkbenchConfig;
pub use request::AssistivePromptConfig;
pub use request::ExperimentalConfig;
pub use request::ToolExecutionRequest;
pub use request::MetaToolExecutionRequest;
pub use request::LinkRequest;
pub use request::AuthConfigData;
pub use request::ConnectedAccountCreateParams;
pub use request::AuthConfigReference;
pub use request::ConnectionData;
pub use response::SessionResponse;
pub use response::McpInfo;
pub use response::ToolSchema;
pub use response::MetaToolExecutionResponse;
pub use toolkits::ToolkitListResponse;
pub use toolkits::ToolkitItem as ToolkitInfo;
pub use toolkits::ToolkitMeta;
pub use response::LinkResponse;
pub use response::ToolRouterMcpServerType;
pub use response::ToolRouterMcpServerConfig;
pub use response::ToolRouterSessionExperimental;
pub use response::ToolkitConnectionAuthConfig;
pub use response::ToolkitConnectedAccount;
pub use response::ToolkitConnection;
pub use response::ToolkitConnectionState;
pub use response::ToolkitConnectionsDetails;
pub use response::ErrorResponse;
pub use response::ConnectedAccountCreateResponse;
pub use response::ConnectedAccountDetail;
pub use response::ConnectedAccountRetrieveResponse;
pub use response::TriggerInstanceUpsertResponse;
pub use triggers::TriggerConnectedAccount;
pub use triggers::TriggerCreateParams;
pub use triggers::TriggerCreateResponse;
pub use triggers::TriggerEvent;
pub use triggers::TriggerInstance;
pub use triggers::TriggerInstanceListParams;
pub use triggers::TriggerInstanceListResponse;
pub use triggers::TriggerMetadata;
pub use triggers::TriggerToolkitRef;
pub use triggers::TriggerType;
pub use triggers::TriggerTypeListParams;
pub use triggers::TriggerTypeListResponse;
pub use triggers::TriggerTypeRetrieveEnumResponse;
pub use triggers::TriggerTypeRetrieveParams;
pub use triggers::VerifyWebhookResult;
pub use triggers::WebhookVerifyParams;
pub use triggers::WebhookVersion;
pub use webhook_events::WebhookEventType;
pub use webhook_events::ConnectedAccountToolkit;
pub use webhook_events::ConnectedAccountAuthConfig;
pub use webhook_events::ConnectionStateVal;
pub use webhook_events::SingleConnectedAccountDetailedResponse;
pub use webhook_events::WebhookConnectionMetadata;
pub use webhook_events::ConnectionExpiredEvent;
pub use webhook_events::WebhookEvent;
pub use webhook_events::is_connection_expired_event;
pub use toolkits::ToolkitListParams;
pub use toolkits::SortBy;
pub use toolkits::ManagedBy;
pub use toolkits::ToolkitRetrieveResponse;
pub use toolkits::ToolkitRetrieveParams;
pub use toolkits::AuthConfigDetail;
pub use toolkits::AuthConfigFields;
pub use toolkits::AuthFieldSet;
pub use toolkits::AuthField;
pub use toolkits::ToolkitCategoriesResponse;
pub use toolkits::ToolkitCategory;
pub use toolkits::AuthorizeParams;

Modules§

auth_configs
Authentication configuration management
base
Base resource structures for Composio client
cli
CLI session models for Composio API.
connected_accounts
Connected accounts management
custom_tools
Custom Tools module
enums
Enums for Composio API
files
File handling for Composio SDK
internal
Internal SDK models and resources
link
Direct connected-account link endpoint models.
mcp
MCP (Model Context Protocol) module for Composio SDK.
migration
Migration models for converting legacy UUIDs to NanoIds.
modifiers
Tool modifiers for customizing tool behavior
project
Project configuration models for Composio API.
request
Request models for Composio API
response
Response models from Composio API
telemetry
Telemetry module for tracking SDK usage and errors
toolkits
Toolkits management
tools
Tools management
triggers
Triggers management
versioning
Toolkit versioning types and utilities
webhook_events
Webhook event types for typed event handling.