H Company Sessions API
The Sessions API from H Company — 15 operation(s) for sessions.
H Company Sessions API is one of 10 APIs that H Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 18 operations across 15 paths, and defines 63 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://agp.eu.hcompany.ai, https://agp.hcompany.ai.
18 operations
15 paths
63 schemas
2 DELETE7 GET8 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
H Company Sessions API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (HTTPBearer).
Paths & Operations 18
Across 15 paths, the API surfaces 18 operations — 2 DELETE, 7 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Sessions 18
POST
/api/v2/sessions
Create Session
GET
/api/v2/sessions
List Sessions
GET
/api/v2/sessions/quota
Get Session Quota
GET
/api/v2/sessions/{id}
Get Session
DELETE
/api/v2/sessions/{id}
Cancel Session
GET
/api/v2/sessions/{id}/status
Get Session Status
POST
/api/v2/sessions/{id}/messages
Send Session Messages
POST
/api/v2/sessions/{id}/tool_results
Send Session Tool Results
POST
/api/v2/sessions/{id}/pause
Pause Session
POST
/api/v2/sessions/{id}/resume
Resume Session
POST
/api/v2/sessions/{id}/force_answer
Force Session Answer
GET
/api/v2/sessions/{id}/changes
Get Session Changes
GET
/api/v2/sessions/{id}/events
List Session Events
POST
/api/v2/sessions/{id}/feedback
Submit Session Feedback
PUT
/api/v2/sessions/{id}/events/{event_index}/feedback
Submit Event Feedback
POST
/api/v2/sessions/{id}/share
Share Session
DELETE
/api/v2/sessions/{id}/share
Unshare Session
GET
/api/v2/sessions/{id}/resources/{bucket}/{key}
Get Session Resource
Schemas 63
The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are Browser (12 properties), SessionRequest (11 properties), SessionChanges (9 properties), Agent (9 properties). Each schema is shown below with its type and property counts.
Desktop
object
A desktop the agent controls via mouse, keyboard, and screenshots.
4 properties
2 required
PolicyEvent
object
One policy (LLM) step: the model output plus the tool requests extracted from it.
5 properties
ActiveStateChangeEvent
object
The agent switched between running, idle and awaiting custom tool results.
3 properties
3 required
Metrics
object
Rolled-up usage and cost for a session.
6 properties
QuotaStatus
object
Quota status.
4 properties
4 required
ValidationError
object
5 properties
3 required
TrajectoryEvent
object
Event from a trajectory. Unified from agpclient and agentplatform. Uses the richer agentplatform version with screenshot serialization. Events represent indivi…
3 properties
3 required
FlowEvent
object
Run-loop control transition (pause, resume, stop, ...).
3 properties
2 required
AgentCompletionData
object
1 property
1 required
ImageContent
object
Image payload: url for platform-served screenshots, base64 for inline images.
3 properties
2 required
ProxyPool
string
The kind of upstream IPs a managed proxy draws from.
ShareLink
object
Public share URL for a session.
1 property
1 required
UserMessageBatch
object
Batch of user messages.
2 properties
1 required
HTTPValidationError
object
1 property
SessionRequest
object
POST /api/v2/sessions body.
11 properties
1 required
Browser
object
A web browser the agent navigates and acts on.
12 properties
1 required
ToolResultBatch
object
Batch of custom tool results.
2 properties
1 required
AnswerEvent
object
Agent's final answer for the current task.
3 properties
1 required
SessionEvent
AgentStartedEvent
object
The agent process started.
3 properties
3 required
TrajectoryStatus
string
State of a session/trajectory. Lifecycle:: QUEUED → PENDING → RUNNING → {COMPLETED, FAILED, TIMEDOUT, INTERRUPTED} | | ↑ ↑ ↑ | | | | └───→ IDLE (interactive: a…
RequestStartEvent
object
The platform requested the agent to start.
3 properties
3 required
AgentRunStatusChangeEvent
object
The run status changed.
3 properties
3 required
Environment
LiveViewUrlEvent
object
A live view URL became available.
3 properties
3 required
BrowserVisualMode
object
Act on screenshots by viewport coordinates.
4 properties
SessionSummary
object
Flat projection for session listings, including child rosters via ?parentsessionid=.
9 properties
3 required
Page_SessionEvent_
object
3 properties
3 required
Agent
object
Declarative agent definition.
9 properties
3 required
MetricsUpdateData
object
1 property
1 required
RequestStartData
object
Empty payload.
JsonValue
AgentErrorEvent
object
The agent run failed.
3 properties
3 required
ErrorEvent
object
Recoverable error raised while running the agent loop.
4 properties
2 required
Feedback
object
Feedback on the semantic success of the trajectory.
2 properties
1 required
BrowserNetwork
object
Network egress settings for a remote browser session.
2 properties
ToolRequest
object
Tool invocation proposed by the policy.
3 properties
1 required
Skill
object
A named, reusable instruction an agent can draw on during a session.
5 properties
3 required
Session
object
Full session envelope: original request + live status.
8 properties
4 required
ToolResultEvent
object
Result of executing one tool request.
3 properties
1 required
BrowserTextMode
object
Read-only markdown with URL navigation, no screenshots.
2 properties
AgentCompletionEvent
object
The agent run completed.
3 properties
3 required
MetricsUpdateEvent
object
Rolled-up usage and cost metrics for the session.
3 properties
3 required
MessageEvent
object
Message exchanged with the agent (user, system or subagent).
3 properties
1 required
ModelUsage
object
Per-model token usage.
4 properties
4 required
ManagedProxySelection
object
Request for an H-managed proxy, provisioned per session. Describes intent only — pool, country, stickiness — never credentials; H resolves and injects those wh…
3 properties
AgentStartedData
object
Empty payload.
Page_SessionSummary_
object
3 properties
3 required
ModelCost
object
Token usage and cost for a single model.
8 properties
4 required
AgentRunStatusChangeData
object
1 property
1 required
SessionStatus
object
GET /api/v2/sessions/{id}/status response.
7 properties
1 required
AgentErrorData
object
3 properties
1 required
SessionErrorCode
string
Machine-readable category of a terminal session failure.
SessionChanges
object
Typed view of TrajectoryChanges for Agent API session endpoints.
9 properties
1 required
AnswerOutcome
string
Agent's self-assessment of how the task concluded, reported with the final answer.
ObservationEvent
object
What the agent perceived this step: optional text, screenshot and environment metadata.
5 properties
RequestStartDispatchedEvent
object
The start request was dispatched to a runner.
3 properties
3 required
ToolDefinition
object
Contract for a tool executed by the API client, not by the agent runtime. The agent emits a tool call matching inputschema, pauses, and resumes once the client…
3 properties
2 required
UserMessageEvent
object
The user is sending a message to an active agent.
4 properties
1 required
AgentEvent
object
Event emitted by the agent loop itself; data is discriminated by kind.
3 properties
3 required
RequestStartDispatchedData
object
1 property
1 required
LiveViewUrlData
object
1 property
1 required
ActiveStateChangeData
object
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from H Company 9
Other APIs H Company publishes across the network.
H Company Holo Models API
H Company Agents API
H Company Browser Profiles API
H Company Environments API
H Company quota API
H Company Schedules API
H Company Skills API
H Company Vaults API
H Company Webhooks API
#Sessions