Skip to main content
GET
/
v1
/
knowledge-base
/
audit
/
retrievals
/
{ref}
Get one retrieval-audit log with its scopes and chunk refs
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/audit/retrievals/{ref} \
  --header 'x-api-key: <api-key>'
{
  "log": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "ref": "",
    "retrieval_status": "<string>",
    "serving_decision": "<string>",
    "audit_write_status": "<string>",
    "requested_kb_count": 123,
    "result_count": 123,
    "response_ref_count": 123,
    "eligible_version_count": 123,
    "duration_ms": 123,
    "actor_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rag_query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "query_hash": "<string>",
    "query_hash_key_version": "<string>",
    "query_length_bucket": "<string>",
    "request_id": "<string>",
    "trace_id": "<string>",
    "caller": "<string>",
    "initiator_type": "<string>",
    "principal_type": "<string>",
    "permission": "<string>",
    "permission_decision": "<string>",
    "query_hash_scope": "<string>",
    "query_length": 123,
    "eligible_version_digest": "<string>",
    "ineligible_counts_by_reason": {},
    "policy_version": "<string>",
    "eligibility_rule_version": "<string>",
    "scan_policy_version": "<string>",
    "scan_policy_decision": "<string>",
    "retrieval_config_version": "<string>",
    "embedding_model": "<string>",
    "reranker_model": "<string>",
    "top_k": 123,
    "effective_limit": 123,
    "ranking_mode": "<string>",
    "alpha": 123,
    "reranked": true,
    "error_code": "<string>",
    "error_category": "<string>",
    "intent_recorded_at": "2023-11-07T05:31:56Z",
    "finalized_at": "2023-11-07T05:31:56Z"
  },
  "scopes": [
    {
      "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requested": true,
      "eligible_version_count": 123,
      "result_count": 123,
      "serving_decision": "<string>",
      "scan_policy_decision": "<string>",
      "effective_serving_status_counts": {}
    }
  ],
  "refs": [
    {
      "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "document_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chunk_index": 123,
      "chunk_stable_id": "<string>",
      "chunk_content_hash": "<string>",
      "chunk_content_hash_key_version": "<string>",
      "document_version_content_hash": "<string>",
      "citation_ref": "<string>",
      "source_uri_hash": "<string>",
      "rank": 123,
      "score": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

ref
string
required

Response

Successful Response

A retrieval log plus its scopes (incl. misses/blocks) and chunk refs.

log
RetrievalAuditLogDetail · object
required

Detail view — adds policy/config/error context (still hashes/ids only).

scopes
RetrievalAuditScopeView · object[]
required
refs
RetrievalAuditRefView · object[]
required