Query Agent API

SomebodySysop · April 25, 2025, 6:53am

Description

Can I access the Query Agent API using REST API (i.e., curl) instead of Python?

Mohamed_Shahin · April 25, 2025, 8:57am

At the moment, this isn’t supported yet, but it’s definitely on our radar. We’re currently focusing on enhancing advanced functionality for Agents and extending support across our various clients. Once that’s in place, API support will naturally follow—though we don’t have an exact ETA just yet.

Stay tuned!

Best regards,
Mohamed Shahin
Weaviate Support Engineer
(Ireland, GMT/UTC timezone)

DudaNogueira · April 25, 2025, 12:37pm

Meanwhile… hehehe, you can always “reverse engineer” it.

The code that calls the query agent endpoint lives here:

github.com/weaviate/weaviate-agents-python-client

weaviate_agents/query/query_agent.py

cefe1f97a


      
          
          Args:
              query: The natural language query string for the agent.
              view_properties: Optional list of of property names the agent has the ability to view
                  across all collections.
              context: Optional previous response from the agent.
              target_vector: Optional target vector for the query if a collection uses named vector. When
              mulitple collections are provided to the query agent, a dictionary must be used mapping
              collection names to target vectors.
          """
          request_body = {
              "query": query,
              "collection_names": [
                  c.name if isinstance(c, CollectionDescription) else c
                  for c in self._collections
              ],
              "headers": self._connection.additional_headers,
              "collection_view_properties": view_properties,
              "limit": 20,
              "tenant": None,
              "previous_response": context.model_dump() if context else None,

Be aware that as it is in technical preview, it may change without notice

But as my dear colleague @Mohamed_Shahin said, our team is actively working on it.

Happy coding

SomebodySysop · April 29, 2025, 12:44am

Do you know if we can filter the agent queries? Or somehow restrict the responses to specific collection properties?

Topic		Replies	Views
[Question] Query weaviate Support technical	1	253	March 12, 2025
[Python API feedback] Additional properties General	5	407	July 15, 2023
AttributeError: 'WeaviateClient' object has no attribute 'query' Support python	3	344	December 9, 2024
Need Help Accessing 'include_vector' Property in Weaviate Migration Process Support python	2	69	July 31, 2024
Python `v4` client - feedback megathread! Support developer-experience , python	45	3527	May 31, 2024

Query Agent API

Description

Related topics