Feedback

Get Feedback by Run ID

get

Retrieve feedback for a specific run. Returns null if no feedback exists.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

runIdstringRequired

UUID of the run to get feedback for

Responses

200

Feedback retrieved successfully or null if not found

application/json

401

Unauthorized - invalid API key

404

Run not found

get

/v1/feedback/run/{runId}

HTTPcURLJavaScriptPython

GET /v1/feedback/run/{runId} HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "runId": "text",
  "rating": "positive",
  "comment": "text",
  "feedbackSource": {
    "type": "user",
    "userId": "text",
    "metadata": {
      "device": "text",
      "platform": "text",
      "version": "text",
      "sessionId": "text",
      "userAgent": "text"
    }
  },
  "metadata": {
    "version": "text",
    "sessionId": "text",
    "experimentId": "text",
    "environment": "text",
    "clientVersion": "text"
  },
  "createdAt": "text",
  "updatedAt": "text"
}

Upsert Feedback

put

Create or update feedback for a specific run

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

runIdstringRequired

UUID of the run to provide feedback for

Body

application/json

ratingstring · enumOptional

Required when creating new feedback

Possible values:

commentstringOptional

Responses

200

Feedback successfully created or updated

application/json

400

Invalid request body or parameters

401

Unauthorized - invalid API key

404

Run not found

put

/v1/feedback/run/{runId}

HTTPcURLJavaScriptPython

PUT /v1/feedback/run/{runId} HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "rating": "positive",
  "comment": "text",
  "source": {
    "type": "user",
    "userId": "text",
    "metadata": {
      "device": "text",
      "platform": "text",
      "version": "text",
      "sessionId": "text",
      "userAgent": "text"
    }
  },
  "metadata": {
    "version": "text",
    "sessionId": "text",
    "experimentId": "text",
    "environment": "text",
    "clientVersion": "text"
  }
}

{
  "id": "text",
  "runId": "text",
  "rating": "positive",
  "comment": "text",
  "feedbackSource": {
    "type": "user",
    "userId": "text",
    "metadata": {
      "device": "text",
      "platform": "text",
      "version": "text",
      "sessionId": "text",
      "userAgent": "text"
    }
  },
  "metadata": {
    "version": "text",
    "sessionId": "text",
    "experimentId": "text",
    "environment": "text",
    "clientVersion": "text"
  },
  "createdAt": "text",
  "updatedAt": "text"
}

Get Feedback by ID

get

Retrieve feedback by its ID

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

feedbackIdstringRequired

UUID of the feedback to retrieve

Responses

200

Feedback retrieved successfully

application/json

401

Unauthorized - invalid API key

404

Feedback not found

get

/v1/feedback/{feedbackId}

HTTPcURLJavaScriptPython

GET /v1/feedback/{feedbackId} HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "runId": "text",
  "rating": "positive",
  "comment": "text",
  "feedbackSource": {
    "type": "user",
    "userId": "text",
    "metadata": {
      "device": "text",
      "platform": "text",
      "version": "text",
      "sessionId": "text",
      "userAgent": "text"
    }
  },
  "metadata": {
    "version": "text",
    "sessionId": "text",
    "experimentId": "text",
    "environment": "text",
    "clientVersion": "text"
  },
  "createdAt": "text",
  "updatedAt": "text"
}