# Run with PHP SDK

Use the official `fetch-hive/sdk` Composer package when you want to send a message to an agent from PHP. The SDK wraps the public [`POST /v1/agent/invoke`](/api-reference/invoke-agent.md) endpoint, handles authentication, exposes streaming responses as a generator, and accepts multimodal inputs.

## Installation

```bash
composer require fetch-hive/sdk
```

The SDK requires PHP 8.1+ and uses Guzzle as its HTTP client.

## Authentication

Set the `FETCH_HIVE_API_KEY` environment variable to your workspace API key (the client reads it automatically):

```bash
export FETCH_HIVE_API_KEY=fhk_...
```

```php
<?php
require_once 'vendor/autoload.php';

use FetchHive\Sdk\FetchHive;

$client = new FetchHive();
```

Or pass the key explicitly:

```php
$client = new FetchHive(['api_key' => 'fhk_...']);
```

See [API Keys](/your-workspace/api-keys.md) for how to create and rotate keys.

## Basic example

Send a message to an agent and read the final response:

```php
<?php
require_once 'vendor/autoload.php';

use FetchHive\Sdk\FetchHive;

$client = new FetchHive();

$reply = $client->invokeAgent([
    'agent'   => 'AGENT_UUID',
    'message' => 'Summarize the latest AI infrastructure trends',
]);

echo $reply['response'];
```

See the [non-streaming response shape](/api-reference/invoke-agent.md#response).

## Method reference

| Key          | Type       | Required | Description                                                                                                           |
| ------------ | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
| `agent`      | `string`   | Yes      | The agent ID                                                                                                          |
| `message`    | `string`   | Yes      | The message you want to send                                                                                          |
| `thread_id`  | `string`   | No       | An arbitrary string identifying a persistent conversation thread                                                      |
| `messages`   | `array`    | No       | Caller-managed conversation history. Each item: `['role' => 'user' \| 'assistant' \| 'system', 'content' => string]`. |
| `image_urls` | `string[]` | No       | HTTPS image URLs attached to the current `message` for multimodal inputs                                              |
| `user`       | `string`   | No       | Opaque caller identifier surfaced in [User Tracking](/user-tracking/user-tracking.md)                                 |

The SDK injects `streaming: false` for `invokeAgent`. To stream, use `invokeAgentStream` (below).

## Handling the response

```php
$reply = $client->invokeAgent([
    'agent'   => 'AGENT_UUID',
    'message' => 'Hello',
]);

echo $reply['response'];        // final text
echo $reply['model'];           // model identifier
print_r($reply['usage']);       // token usage breakdown
echo $reply['request_id'];      // use this to look up the run in Logs
print_r($reply['tool_calls']);  // tool invocations made during the run
```

## Streaming

Use `invokeAgentStream` to receive Server-Sent Events as they arrive. The method returns a `Generator`:

```php
foreach ($client->invokeAgentStream([
    'agent'     => 'AGENT_UUID',
    'message'   => 'Summarize the latest AI infrastructure trends',
    'thread_id' => 'user-456-support-session',
]) as $chunk) {
    match ($chunk['type']) {
        'response' => print($chunk['response'] ?? ''),
        'tool'     => print("\nCalling tool: " . ($chunk['tool'] ?? '')),
        'usage'    => print("\n\nUsage: " . json_encode($chunk['usage'])),
        default    => null,
    };
}
```

The stream yields the same event types documented in [Invoke Agent → Response](/api-reference/invoke-agent.md#response): `summary` (when auto-summarization fires), `reasoning`, `response`, `tool`, and a final `usage` event.

## Multi-turn conversations

### Persistent threads

Pass any string as `thread_id` and Fetch Hive will create the thread on the first call and resume it on subsequent calls with the same value:

```php
$client->invokeAgent([
    'agent'     => 'AGENT_UUID',
    'message'   => 'What are the main AI infrastructure trends right now?',
    'thread_id' => 'user-456-support-session',
]);

$client->invokeAgent([
    'agent'     => 'AGENT_UUID',
    'message'   => 'Which of those trends have the most enterprise adoption?',
    'thread_id' => 'user-456-support-session',
]);
```

### Stateless history

Manage state yourself by passing the previous turns in `messages`. Fetch Hive uses the supplied history for context but does not persist it:

```php
$client->invokeAgent([
    'agent'    => 'AGENT_UUID',
    'message'  => 'Which of those trends have the most enterprise adoption?',
    'messages' => [
        ['role' => 'user',      'content' => 'What are the main AI infrastructure trends right now?'],
        ['role' => 'assistant', 'content' => 'Teams are focusing on evals, tool routing, and observability.'],
    ],
]);
```

## Multimodal inputs

Attach images to the current message with `image_urls`:

```php
$result = $client->invokeAgent([
    'agent'      => 'vision-agent',
    'message'    => 'Describe this image',
    'image_urls' => ['https://example.com/photo.jpg'],
]);
echo $result['response'];
```

URLs must start with `https://`.

## Configuration

| Option     | Default                        | Description                     |
| ---------- | ------------------------------ | ------------------------------- |
| `api_key`  | `FETCH_HIVE_API_KEY` env var   | Bearer token from the dashboard |
| `base_url` | `https://api.fetchhive.com/v1` | Override the API base URL       |
| `timeout`  | `120`                          | Request timeout in seconds      |

```php
$client = new FetchHive([
    'api_key'  => 'fhk_...',
    'base_url' => 'https://api.fetchhive.com/v1',
    'timeout'  => 120.0,
]);
```

## Errors

Non-2xx responses throw `FetchHive\Sdk\Exception\ApiException` carrying the status code and response body:

```php
use FetchHive\Sdk\Exception\ApiException;

try {
    $reply = $client->invokeAgent([
        'agent'   => 'AGENT_UUID',
        'message' => 'Hello',
    ]);
} catch (ApiException $e) {
    error_log('Fetch Hive error: ' . $e->getMessage());
}
```

See [Errors and Rate Limits](/api-reference/errors-and-rate-limits.md) for status code meanings.

## Links

* [Package on Packagist](https://packagist.org/packages/fetch-hive/sdk)
* [Source on GitHub](https://github.com/Fetch-Hive/php-sdk)

## Next steps

* [Run with API](/agents/run-with-api.md) - The same flow with cURL
* [Run with Python SDK](/agents/run-with-python-sdk.md)
* [Run with Node.js SDK](/agents/run-with-nodejs-sdk.md)
* [Run with Ruby SDK](/agents/run-with-ruby-sdk.md)
* [Invoke Agent](/api-reference/invoke-agent.md) - Full endpoint reference


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fetchhive.com/agents/run-with-php-sdk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.