Skip to main content
Use the official fetch-hive/sdk Composer package when you want to invoke a prompt deployment from PHP. The SDK wraps the public POST /v1/prompt/invoke endpoint with an idiomatic facade, handles authentication, and exposes streaming responses as a generator of parsed event arrays.

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

Invoke a prompt deployment and read the final response:
invokePrompt blocks until the prompt completes and returns the parsed JSON body as an associative array. See the non-streaming response shape.

Method reference

The SDK injects streaming: false for invokePrompt. To stream, use invokePromptStream (below).

Handling the response

Streaming

Use invokePromptStream to receive Server-Sent Events as they arrive. The method returns a Generator you can iterate with foreach:
The stream yields the same event types documented in Invoke Prompt → Response: reasoning, response, a final usage event, or an error event if the provider fails mid-stream.

Configuration

Errors

Non-2xx responses throw FetchHive\Sdk\Exception\ApiException carrying the status code and response body. Catch it if you need to handle failures:
See Errors and Rate Limits for status code meanings.

Next steps