Skip to main content
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 endpoint, handles authentication, exposes streaming responses as a generator, and accepts multimodal inputs.

Installation

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):
Or pass the key explicitly:
See API Keys for how to create and rotate keys.

Basic example

Send a message to an agent and read the final response:
See the non-streaming response shape.

Method reference

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

Handling the response

Streaming

Use invokeAgentStream to receive Server-Sent Events as they arrive. The method returns a Generator:
The stream yields the same event types documented in Invoke Agent → Response: summary (when auto-summarization fires), reasoning, response, tool, a final usage event, or an error event if the provider fails mid-stream.

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:

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:

Multimodal inputs

Attach images to the current message with attachments:
URLs must start with https://.

Configuration

Errors

Non-2xx responses throw FetchHive\Sdk\Exception\ApiException carrying the status code and response body:
See Errors and Rate Limits for status code meanings.

Next steps

Tool approvals

When a tool needs approval, the invoke response has status: "awaiting_approval" and pending_tool_approvals. Decide with decideToolActionApproval(workspaceId, approvalId, "allow_once") or "deny". List pending approvals with listToolActionApprovals, or fetch one with getToolActionApproval. always_allow is only available in the dashboard. An API key call resumes on the server after the decision. Poll the run or use the webhook. Do not send decided_tool_approvals. A workspace owner or admin can allow this API key to auto-approve actions in Settings → API keys. Pass tool_approval: "auto_approve" on invokeAgent, invokeAgentStream, or invokeWorkflow. That applies to this call only. Omit the field, or send "policy", to follow workspace rules and any saved auto-approve switch. Destructive actions still ask. Deny rules still block the action. See Tool approvals.