Expand description
elizaOS xAI Plugin
This crate provides xAI Grok model support and Twitter API v2 integration for elizaOS agents.
§Features
- xAI Grok models for text generation and embeddings
- Full Twitter API v2 client for X platform (posts, timelines, users, search)
- OAuth 1.0a and Bearer token authentication
- Async/await with Tokio runtime
§Example
use elizaos_plugin_xai::{GrokClient, GrokConfig, TwitterClient, TwitterConfig};
use elizaos_plugin_xai::grok::TextGenerationParams;
// Grok client
let grok = GrokClient::new(GrokConfig::from_env()?)?;
let result = grok.generate_text(&TextGenerationParams::new("Hello"), false).await?;
// X client
let mut x = TwitterClient::new(TwitterConfig::from_env()?)?;
let me = x.me().await?;
println!("Logged in as @{}", me.username);Re-exports§
pub use crate::actions::PostAction;pub use crate::actions::PostActionResult;pub use crate::client::TwitterClient;pub use crate::grok::EmbeddingParams;pub use crate::grok::GrokClient;pub use crate::grok::GrokConfig;pub use crate::grok::TextGenerationParams;pub use crate::models::TextEmbeddingHandler;pub use crate::models::TextLargeHandler;pub use crate::models::TextSmallHandler;pub use crate::types::TwitterConfig;pub use crate::services::XService;pub use crate::services::XServiceSettings;
Modules§
- actions
- Actions for the xAI plugin.
- client
- error
- Error types for the xAI plugin (Grok and Twitter API).
- grok
- xAI Grok Client
- models
- Model handlers for the xAI plugin.
- services
- X (Twitter) services for elizaOS agents.
- types
- Type definitions for xAI and Twitter API v2.
Functions§
- create_
xai_ elizaos_ plugin - Create an elizaOS
elizaos::types::Pluginwired to Grok model handlers. - get_
grok_ client - Build a Grok (xAI) client from environment configuration.
- get_
x_ client - Build a Twitter/X API client from environment configuration.
- start_
x_ service - Start the X background service and register it with the runtime.