Download the PHP package grok-php/client without Composer
On this page you can find all versions of the php package grok-php/client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download grok-php/client
More information about grok-php/client
Files in grok-php/client
Package client
Short Description Grok PHP Client is a robust and community-driven PHP client library for seamless integration with Grok AI API, offering efficient access to advanced AI and data processing capabilities.
License MIT
Homepage https://github.com/grok-php/client
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package client
🧠 Grok PHP Client
A lightweight, framework-agnostic PHP client for interacting with Grok AI APIs. Supports PHP 8.2+, built with OOP best practices, and fully type-safe.
📖 Table of Contents
- Features
- Installation
- Quick Start
- Basic Usage
- Vision Analysis
- Advanced Configuration
- Available Grok AI Models
- Streaming Responses
- Response format
- Error Handling
- Testing
- Security
- Contributing
- License
Features
- Easy Integration – Seamlessly connects with Grok AI APIs.
- Modern PHP Features – Utilizes PHP 8.2+ features like enums and traits.
- Framework Agnostic – Works with any PHP project, CLI scripts, or web applications.
- Streaming Support – Built-in support for real-time responses.
- Lightweight & Efficient – Optimized with PSR-4 autoloading and minimal dependencies.
Installation
Install via Composer:
Requirements:
- PHP 8.2+
- Composer 2.0+
Quick Start
Basic Usage
Defaults Used:
- Model:
grok-2 - Temperature:
0.7 - Streaming:
false
Vision Analysis (Image Recognition)
The Vision API allows you to send images for analysis using Grok-2-Vision models.
Supported Models for Vision
| Model Enum | API Model Name | Description |
|---|---|---|
Model::GROK_2_VISION |
grok-2-vision | Base Vision Model |
Model::GROK_2_VISION_LATEST |
grok-2-vision-latest | Latest Vision Model |
Model::GROK_2_VISION_1212 |
grok-2-vision-1212 | Default model for image analysis |
Note: If you attempt to use an unsupported model for vision, an exception will be thrown.
Advanced Configuration
Available Grok AI Models
Grok AI offers multiple models optimized for different use cases.
These models are available in the Model enum inside our package:
📄 src/Enums/Model.php
| Model Enum | API Model Name | Description |
|---|---|---|
Model::GROK_VISION_BETA |
grok-vision-beta | Experimental vision-enabled model |
Model::GROK_2_VISION |
grok-2-vision | Advanced multi-modal vision model |
Model::GROK_2_VISION_LATEST |
grok-2-vision-latest | Latest iteration of Grok vision models |
Model::GROK_2_VISION_1212 |
grok-2-vision-1212 | Enhanced vision model with performance improvements |
Model::GROK_2_1212 |
grok-2-1212 | Optimized chat model |
Model::GROK_2 |
grok-2 | Default general-purpose Grok model |
Model::GROK_2_LATEST |
grok-2-latest | Latest iteration of Grok-2 |
Model::GROK_BETA |
grok-beta | Experimental beta model |
Default model used: Model::GROK_2
Streaming Responses
The Grok API supports streaming responses for real-time interaction.
Enable it by setting stream: true:
Streaming can be useful for chatbots, real-time applications, and CLI assistants.
Response format
The Grok API supports setting a response format, also refered to structured outputs, for the grok-2-1212 model.
Error Handling
This package includes built-in error handling with a dedicated exception class. Common errors and their messages:
| Error Type | HTTP Code | Message |
|---|---|---|
Invalid API Key |
400 | No API key provided. Specify your API key. |
Invalid Request |
400 | Client specified an invalid argument. |
Invalid Role |
422 | Unknown role variant provided in messages. |
Example of handling exceptions:
Testing
Run the tests with PHPUnit:
Or run PHPUnit manually:
Security
If you discover a security vulnerability, please report it via email: 📩 [email protected]
Contributing
Want to improve this package? Check out CONTRIBUTING.md for contribution guidelines.
License
This package is open-source software licensed under the MIT License.
