Skip to main content

API Schema

title: API Schema ---# API Schema

Grok API Integration​

Base Configuration​

{
baseURL: "https://api.x.ai/v1",
defaultModel: "grok-code-fast-1",
apiKey: process.env.GROK_API_KEY
}

Available Models​

- grok-4-latest: Latest Grok model with enhanced capabilities - grok-code-fast-1: Optimized for code generation (default) - grok-3-fast: Fast general-purpose model

Tool Integration Schema​

Tools follow OpenAI function calling format:

interface ToolCall {
id: string;
type: "function";
function: {
name: string;
arguments: string; // JSON stringified
};
}

interface ToolResult {
success: boolean;
output?: string;
error?: string;
}

MCP Server Schema​

Model Context Protocol integration:

interface MCPServerConfig {
name: string;
transport: {
type: 'stdio' | 'http' | 'sse' | 'streamable_http';
command?: string;
args?: string[];
url?: string;
env?: Record<string, string>;
headers?: Record<string, string>;
};
}

Internal APIs​

Agent Interface​

interface GrokAgent {
processUserMessageStream(input: string): AsyncGenerator<StreamChunk>;
executeBashCommand(command: string): Promise<ToolResult>;
setModel(model: string): void;
getCurrentModel(): string;
}

Tool Interface​

interface Tool {
name: string;
description: string;
parameters: JSONSchema7;
execute(args: any): Promise<ToolResult>;
}

Updated: 2025-10-11