# components.responses.BadRequest.content.application/json.examples.invalidParameter.value.message
limit must be an integer between 1 and 100.

# components.responses.NotFound.description
The resource does not exist for the authenticated agent.

# components.responses.RateLimited.content.application/json.examples.tooManyRequests.value.message
Too many requests. Please try again later.

# components.responses.RateLimited.description
Too many requests. Retry after the number of seconds in Retry-After.

# components.responses.ServiceUnavailable.description
The API is temporarily unavailable. The request was not processed.

# components.responses.Unauthorized.content.application/json.examples.invalidKey.value.message
The supplied API key is invalid or revoked.

# components.responses.Unauthorized.description
The Agent API key is missing, invalid, or revoked.

# components.responses.Unauthorized.headers.WWW-Authenticate.description
The HTTP Bearer authentication challenge.

# components.schemas.Message.properties.parts.description
AI SDK message parts as they were persisted for this conversation.

# components.schemas.User.properties.identity_type.description
The observed identity kind. Current integrations use anonymous, user, or preview; legacy rows can report unknown.

# components.securitySchemes.AgentApiKey.description
An Agent API key with the permission required by the operation.

# info.description
View users, conversations, messages, and runs captured by a HeroUI Agent. Every request is scoped to the agent that owns the supplied API key.

# paths./conversations.get.description
Returns conversations for the authenticated agent, ordered from most recently updated to oldest. Message content is available from List conversation messages.

# paths./conversations.get.parameters[].description
The maximum number of objects to return. Defaults to 20 and is capped at 100.

# paths./conversations.get.parameters[].description
An opaque cursor returned by the previous page.

# paths./conversations.get.responses.403.content.application/json.examples.insufficientScope.value.message
This API key does not have the required conversations:read permission.

# paths./conversations.get.responses.403.description
The API key does not have the required permission.

# paths./conversations.get.responses.403.headers.WWW-Authenticate.description
A Bearer challenge identifying the missing permission.

# paths./conversations/{id}.get.description
Returns one conversation that belongs to the authenticated agent.

# paths./conversations/{id}.get.responses.403.content.application/json.examples.insufficientScope.value.message
This API key does not have the required conversations:read permission.

# paths./conversations/{id}.get.responses.403.description
The API key does not have the required permission.

# paths./conversations/{id}.get.responses.403.headers.WWW-Authenticate.description
A Bearer challenge identifying the missing permission.

# paths./conversations/{id}/messages.get.description
Returns persisted messages for one conversation, ordered from oldest to newest. The conversation must belong to the authenticated agent.

# paths./conversations/{id}/messages.get.parameters[].description
The maximum number of objects to return. Defaults to 20 and is capped at 100.

# paths./conversations/{id}/messages.get.parameters[].description
An opaque cursor returned by the previous page.

# paths./conversations/{id}/messages.get.responses.403.content.application/json.examples.insufficientScope.value.message
This API key does not have the required conversations:read permission.

# paths./conversations/{id}/messages.get.responses.403.description
The API key does not have the required permission.

# paths./conversations/{id}/messages.get.responses.403.headers.WWW-Authenticate.description
A Bearer challenge identifying the missing permission.

# paths./runs.get.description
Returns model runs for the authenticated agent, ordered from newest to oldest. Provider-native raw usage payloads are never exposed.

# paths./runs.get.parameters[].description
The maximum number of objects to return. Defaults to 20 and is capped at 100.

# paths./runs.get.parameters[].description
An opaque cursor returned by the previous page.

# paths./runs.get.responses.403.content.application/json.examples.insufficientScope.value.message
This API key does not have the required runs:read permission.

# paths./runs.get.responses.403.description
The API key does not have the required permission.

# paths./runs.get.responses.403.headers.WWW-Authenticate.description
A Bearer challenge identifying the missing permission.

# paths./runs/{id}.get.description
Returns one model run that belongs to the authenticated agent.

# paths./runs/{id}.get.responses.403.content.application/json.examples.insufficientScope.value.message
This API key does not have the required runs:read permission.

# paths./runs/{id}.get.responses.403.description
The API key does not have the required permission.

# paths./runs/{id}.get.responses.403.headers.WWW-Authenticate.description
A Bearer challenge identifying the missing permission.

# paths./users.get.description
Returns users observed by the authenticated agent, ordered from most recently seen to oldest.

# paths./users.get.parameters[].description
The maximum number of objects to return. Defaults to 20 and is capped at 100.

# paths./users.get.parameters[].description
An opaque cursor returned by the previous page.

# paths./users.get.responses.403.content.application/json.examples.insufficientScope.value.message
This API key does not have the required users:read permission.

# paths./users.get.responses.403.description
The API key does not have the required permission.

# paths./users.get.responses.403.headers.WWW-Authenticate.description
A Bearer challenge identifying the missing permission.

# paths./users/{id}.get.description
Returns one user that belongs to the authenticated agent.

# paths./users/{id}.get.responses.403.content.application/json.examples.insufficientScope.value.message
This API key does not have the required users:read permission.

# paths./users/{id}.get.responses.403.description
The API key does not have the required permission.

# paths./users/{id}.get.responses.403.headers.WWW-Authenticate.description
A Bearer challenge identifying the missing permission.

# tags[].description
People identified by your Agent integration.

# tags[].description
Conversation metadata and message transcripts.

# tags[].description
Model run status, usage, latency, and tool activity.