POST
/
v1
/
collection
/
query
curl --request POST \
  --url https://api.wetrocloud.com/v1/collection/query/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'collection_id={{collection_id}}' \
  --form 'request_query=What were the major milestones during Queen Elizabeth II'\''s reign?' \
  --form 'json_schema={
  "type": "object",
  "properties": {
    "question": {
      "type": "string",
      "description": "The question being asked."
    },
    "milestones": {
      "type": "array",
      "description": "A list of significant milestones during Queen Elizabeth II'\''s reign.",
      "items": {
        "type": "object",
        "properties": {
          "year": {
            "type": "string",
            "description": "The year when the milestone occurred."
          },
          "event": {
            "type": "string",
            "description": "A brief description of the milestone or event."
          }
        },
        "required": ["year", "event"]
      }
    }
  },
  "required": ["question", "milestones"]
}
' \
  --form 'json_schema_rules=[
  "Ask for specific milestones or events during Queen Elizabeth II'\''s reign, including years and brief descriptions.",
  "Ensure the year and event description for each milestone is accurate and clear.",
  "Limit event descriptions to concise, relevant information without excessive detail.",
  "Focus on significant events from Queen Elizabeth II'\''s reign, starting from 1952 onward."
]
'
{
  "response": "Queen Elizabeth II was the monarch of the United Kingdom and other Commonwealth realms. She served as the Supreme Governor of the Church of England and was a member of the Church of Scotland. Her reign included significant events such as her first state visit to China and her address to a joint meeting of the United States Congress. Elizabeth was known for her involvement in various state matters and her response to public scrutiny regarding the royal family's affairs. She was also noted for her wealth, which included state assets, and her efforts to modernize the monarchy during her reign.",
  "tokens": 5224,
  "success": true
}

Authorizations

​
Authorization
string
header
required

Body

multipart/form-data
​
collection_id
string
Example:

"{{collection_id}}"

​
request_query
string
Example:

"What were the major milestones during Queen Elizabeth II's reign?"

​
json_schema
string
Example:

"{\n \"type\": \"object\",\n \"properties\": {\n \"question\": {\n \"type\": \"string\",\n \"description\": \"The question being asked.\"\n },\n \"milestones\": {\n \"type\": \"array\",\n \"description\": \"A list of significant milestones during Queen Elizabeth II's reign.\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"year\": {\n \"type\": \"string\",\n \"description\": \"The year when the milestone occurred.\"\n },\n \"event\": {\n \"type\": \"string\",\n \"description\": \"A brief description of the milestone or event.\"\n }\n },\n \"required\": [\"year\", \"event\"]\n }\n }\n },\n \"required\": [\"question\", \"milestones\"]\n}\n"

​
json_schema_rules
string
Example:

"[\n \"Ask for specific milestones or events during Queen Elizabeth II's reign, including years and brief descriptions.\",\n \"Ensure the year and event description for each milestone is accurate and clear.\",\n \"Limit event descriptions to concise, relevant information without excessive detail.\",\n \"Focus on significant events from Queen Elizabeth II's reign, starting from 1952 onward.\"\n]\n"

Response

200
application/json
OK

The response is of type object.