TAtavily

Submit feedback on a search request or session

Changed on

Submit feedback on how relevant and useful Tavily's results were for your task.

post/feedback

Request

  • Base URL
    https://api.tavily.com
  • URL
    https://api.tavily.com/feedback
  • Auth
    HTTP bearer

Request body

request_idstring

The search request to give feedback on, as returned in the request_id field of the search response. When provided, the feedback applies to this request.

session_idstring

The session to give feedback on — the value you sent in the X-Session-Id header. When request_id is omitted, the feedback applies to the whole session. Optional if request_id is provided.

commentstring

Free-text explanation of the feedback.

response_deliveredstring

The final answer you produced using the results.

used_idsstring[]

IDs of the results you actually used in your answer. Alternative to used_urls.

used_urlsstring[]

URLs of the results you actually used in your answer. Alternative to used_ids.

used_citationsstring[]

The specific content snippets you quoted from the results.

Example request

{
  "request_id": "8442d8d0-8b74-4fca-a89e-5b1b6dd33295",
  "session_id": "5874812a-2e9b-43ea-8978-6cc9225b587b",
  "extra_scores": [
    {
      "label": "freshness",
      "value": 0.4
    },
    {
      "label": "authority",
      "value": 0.9
    }
  ],
  "comment": "Results were authoritative but several were more than a year old.",
  "response_delivered": "Lionel Messi is an Argentine footballer born in 1987...",
  "used_ids": [
    "a3f9c2-04",
    "a3f9c2-07"
  ],
  "used_urls": [
    "https://www.britannica.com/facts/Lionel-Messi"
  ],
  "used_citations": [
    "Messi is known for his exceptional dribbling skills, vision, and goal-scoring ability."
  ],
  "urls_scores": [
    {
      "id": "a3f9c2-04",
      "agent_score": 1,
      "comment": "Directly answered the question."
    },
    {
      "url": "https://example.com/stale-page",
      "agent_score": -1,
      "scores": [
        {
          "label": "freshness",
          "value": 0.1
        }
      ]
    }
  ]
}

Response

Feedback accepted

successboolean

Whether the feedback was accepted.

feedback_idstring

Unique identifier of this feedback submission.

response_timenumber

Response time of this feedback request in seconds.

Example response

{
  "success": true,
  "feedback_id": "f1c0f0a5-0f9b-4a62-9e0e-1b6b2f0a6d31",
  "response_time": 0.05
}

Changes