Docs API Reference SDK Reference Agentic Usage AI Skills

Account

Submit Tavily feedback

Submit relevance and usefulness feedback for a search request or session. BazaarLink accepts the request and returns Tavily's success shape, but feedback is accepted and not processed yet. Provide at least request_id or session_id; X-Session-Id can identify a session.

POST/v1/feedback

Authorizations

Authorizationrequired

string · header

API key as bearer token in the Authorization header.

Body

request_id

string

Search request to comment on; when provided, feedback applies to that request.

maxLength: 200

Example: 8442d8d0-8b74-4fca-a89e-5b1b6dd33295

session_id

string

Session to comment on; when request_id is omitted, feedback applies to the whole session.

maxLength: 200

Example: 5874812a-2e9b-43ea-8978-6cc9225b587b

agent_score

number | string

Overall agent score for result relevance and usefulness.

string maxLength: 64

Example: 1

human_score

number | string

End-user score, if you collect it.

string maxLength: 64

Example: 1

extra_scores

array<object>

Additional labeled dimensions; each item requires label and value.

maxItems: 50

labelrequired

string

Name of the dimension being scored.

maxLength: 64

Example: freshness

valuerequired

number | string

A numeric score or a short string label of at most 64 characters.

string maxLength: 64

Example: 0.8

comment

string

Free-text explanation of the feedback.

maxLength: 10000

Example: Results were authoritative but several were old.

response_delivered

string

The final answer you produced using the results.

maxLength: 50000

Example: The results show that ...

used_ids

string[]

IDs of results used in the answer; an alternative to used_urls.

maxItems: 100; item maxLength: 200

Example: ["a3f9c2-04"]

used_urls

string[]

URLs of results used in the answer; an alternative to used_ids.

maxItems: 100; item maxLength: 2000

Example: ["https://example.com/article"]

used_citations

string[]

Specific source snippets quoted in the answer.

maxItems: 100; item maxLength: 2000

Example: ["A cited sentence."]

urls_scores

array<object>

Per-result feedback; each item must include id or url.

maxItems: 100

id

string

Result ID from the search response; provide this or url.

maxLength: 200

Example: a3f9c2-04

url

string

Result URL; use this when you do not have the result ID, and provide it or id.

maxLength: 2000

Example: https://example.com/article

agent_score

number | string

Agent score for this result, as a number or short string.

string maxLength: 64

Example: 1

scores

array<object>

Additional labeled scores for this result; each item has label and value.

maxItems: 20

labelrequired

string

Name of the dimension being scored.

maxLength: 64

Example: freshness

valuerequired

number | string

A numeric score or a short string label of at most 64 characters.

string maxLength: 64

Example: 0.8

comment

string

Free-text feedback about this result.

maxLength: 2000

Example: Directly answered the question.

POST /v1/feedback

1
2
3
4
curl -X POST https://api.bazaarlink.ai/v1/feedback \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"request_id":"8442d8d0-8b74-4fca-a89e-5b1b6dd33295","agent_score":1,"used_ids":["a3f9c2-04"]}'

Response examples

Feedback was accepted and the response includes feedback_id and response_time. The feedback content is not processed yet.

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