Skip to main content

Invoke Agent

POST 

/v1/agents/:agent_id/versions/:version_id/invoke

Invoke an agent with the provided messages and return the complete response. Use latest as the version_id to invoke the most recent version. The request body accepts messages, optional guardrails, and agent-type-specific parameters such as hxqlQuery for RAG agents.

Status Codes:

  • 200: Agent invoked successfully
  • 400: Validation error (invalid input, extra/unknown fields, or incompatible agent type)
  • 404: Agent or version not found
  • 500: Internal server error
  • 502: The model's response was cut off because it reached the configured max_tokens limit. Increase inferenceConfig.maxTokens and retry.

Request

Responses

Successful Response