> ## Documentation Index
> Fetch the complete documentation index at: https://hub.hcompany.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> H Platform has three products: the Agents API (managed computer-use agents, base URL https://agp.eu.hcompany.ai/api/v2 or https://agp.hcompany.ai/api/v2 for the US), the Models API (OpenAI-compatible Holo vision-language models at https://api.hcompany.ai/v1), and HoloTab (a free no-code Chrome extension that runs Holo in the user's browser, with recordable routines and schedules). The `holo` CLI (`pip install "hai-agents[cli]"`) runs Agents API agents from a terminal, drives the user's own desktop with `-a h/holo-desktop`, and serves coding agents through `holo mcp`.
> Authenticate with a bearer API key from the HAI_API_KEY environment variable. SDKs: `pip install hai-agents` (Python, `from hai_agents import Client`) and `npm install hai-agents` (TypeScript, `import { HaiAgentsClient } from "hai-agents"`). CLI: `holo`.
> Agents do work in a browser or on a desktop; describe the task as an imperative instruction. To run a task quickly, prefer the pre-built agent `h/web-surfer-flash`. Read results from the session's `latest_answer` after it reaches a terminal status.
> Sessions are the unit of work; wait for a terminal status (completed, failed, timed_out, interrupted) before reading the answer. Use webhooks or the `changes` long-poll endpoint to follow progress.

# Patch an agent

> Patch some fields of an agent and keep the rest.

## Behavior

Each patch is saved as a new [revision](https://hub.hcompany.ai/agents-api/agents/overview.md#revisions). Send `null` to clear an optional field. `description` and `environments` can't be `null`. The merged result is validated like a [full update](https://hub.hcompany.ai/agents-api/agents/update.md).

## Headers

**If-Match** `string`

The `ETag` of the revision you based this change on, for example `"3"`. If the agent has moved past it, the write fails with `412`. Omit it, or send `*`, to apply your fields to whatever is current.

## Path parameters

**agent\_name** `string` *required*

The agent's `name`, for example `my-research-bot` or `myorg/web-helper`.

## Query parameters

**message** `string`

A note stored on the new revision, such as why you made the change. Up to 500 characters. Shown by [List revisions](https://hub.hcompany.ai/agents-api/agents/list-revisions.md).

## Request body

Any subset of these [agent fields](https://hub.hcompany.ai/agents-api/agents/create.md#request-body): `description`, `environments`, `model`, `reasoning_effort`, `instructions`, `subagents`, `skills`, `answer_format`, `tools`. `name` can't change.

## Response

`200` with the updated [agent object](https://hub.hcompany.ai/agents-api/agents/retrieve.md#response), with its new revision in the `ETag` header.

```python Python theme={"system"}
from hai_agents import Client

client = Client()

agent = client.agents.patch_agent(
    agent_name="my-research-bot",
    instructions="Always cite the page you took each claim from.",
)
print(agent.instructions)
```

```typescript TypeScript theme={"system"}
import { HaiAgentsClient } from "hai-agents";

const client = new HaiAgentsClient();

const agent = await client.agents.patchAgent({
  agentName: "my-research-bot",
  instructions: "Always cite the page you took each claim from.",
});
console.log(agent.instructions);
```

```bash cURL theme={"system"}
curl -X PATCH https://agp.eu.hcompany.ai/api/v2/agents/my-research-bot \
  -H "Authorization: Bearer $HAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instructions": "Always cite the page you took each claim from."}'
```

## Errors

| Status | Cause |
| - | - |
| `400` | `If-Match` is not a single revision tag. |
| `403` | The agent is reserved (`h/`) and read-only. |
| `404` | Not found, or not in your organization. Also sent when a skill, environment, or subagent it references is missing. |
| `409` | Without `If-Match`, the agent kept changing while the patch was merged. Retry. |
| `412` | `If-Match` names a revision that isn't the current one. The `ETag` header has the current one: read it, reapply your change, and retry. |
| `422` | The merged spec fails validation, for example `environments` emptied on an agent with no `subagents` or `tools`, or `null` for `description` or `environments`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.