ObjectiveService
Objectives

Submit feedback for an objective

Changed on

Submits feedback for an objective's execution. Feedback scores are used by the agent variation scoring system to evaluate and rank variation performance.

post/v1/workspaces/{workspaceId}/objectives/{objectiveId}/feedback

Request

  • Base URL
    https://api.cadenya.com
  • URL
    https://api.cadenya.com/v1/workspaces/{workspaceId}/objectives/{objectiveId}/feedback
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
objectiveIdstring required
Example:obj_01HXKD2E5NQM3T9AYWCFQAZGFV

The ID of the objective. Supports "external_id:" prefix for external IDs.

Request body

workspaceIdstring
objectiveIdstring

The ID of the objective. Supports "external_id:" prefix for external IDs.

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "objectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV"
}

Response

OK

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "submittedBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}

Changes

  • 06e0e37c1499Revision changes
    • info

      added the optional property /////// to the response with the status

  • 0702cb021b66Revision changes
    • warning

      added the new PROFILE_TYPE_UNSPECIFIED enum value to the /////// response property for the response status