Skip to content

Validate Metrics Request

POST
/api/agents/metrics/validate-request

Validate and document request model structures for metrics endpoints.

Provides validation and documentation for the various request models used in agent communication, helping clients understand the expected formats for AgentMessageRequest, ConsultationRequestModel, AgentHandoffRequest, and MultiAgentConversationRequest.

Query Parameters:

  • request_type: Type of request to document (message, consultation, handoff, conversation)

Returns:

  • request_type: The requested type
  • model_class: The Pydantic model class name
  • required_fields: List of required fields
  • optional_fields: List of optional fields with defaults
  • example: Example valid request structure

Raises:

  • HTTPException 400: If invalid request_type
  • HTTPException 500: For unexpected errors
request_type
Request Type
string
default: message

Successful Response

Response Validate Metrics Request Api Agents Metrics Validate Request Post
object
key
additional properties
any

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object