Review A Merge Proposal

POST

/v1/convai/agents/:agent_id/merge-proposals/:merge_proposal_id/reviews

POST

/v1/convai/agents/:agent_id/merge-proposals/:merge_proposal_id/reviews

curl -X POST https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/merge-proposals/agtmprop_8901k4t9z5defmb8vh3e9361y7nj/reviews \
     -H "Content-Type: application/json" \
     -d '{
  "state": "approved"
}'

{
  "id": "id",
  "agent_id": "agent_id",
  "source_branch_id": "source_branch_id",
  "target_branch_id": "target_branch_id",
  "source_tip_version_id_at_creation": "source_tip_version_id_at_creation",
  "title": "title",
  "created_at": 1,
  "updated_at": 1,
  "description": "description",
  "requested_reviewer_user_ids": [
    "requested_reviewer_user_ids"
  ],
  "reviews": [
    {
      "user_id": "user_id",
      "state": "approved",
      "submitted_at": 1,
      "comment": "comment",
      "reviewer_role": "admin"
    }
  ],
  "comments": [
    {
      "id": "id",
      "user_id": "user_id",
      "body": "body",
      "created_at": 1
    }
  ],
  "outcome": {
    "status": "closed",
    "at": 1,
    "reason": "withdrawn",
    "by_user_id": "by_user_id"
  },
  "author_user_id": "author_user_id",
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin",
    "anonymous_access_level_override": "admin",
    "access_source": "creator"
  }
}

Approve a merge_proposal or request changes on it. A user’s latest review replaces their previous one. Non-admins need an approval from another user before the merge is allowed.

Path parameters

agent_idstringRequired

The id of an agent. This is returned on agent creation.

merge_proposal_idstringRequired

Unique identifier for the merge_proposal.

Request

This endpoint expects an object.

stateenumRequired

The review verdict.

Allowed values:

commentstringOptional<=4096 charactersDefaults to

Optional comment to leave with the review.

Response

Successful Response

idstring

agent_idstring

source_branch_idstring

target_branch_idstring

source_tip_version_id_at_creationstring

titlestring

created_atinteger

updated_atinteger

descriptionstringOptionalDefaults to

requested_reviewer_user_idslist of stringsOptional

reviewslist of objectsOptional

commentslist of objectsOptional

outcomeobjectOptional

author_user_idstringOptional

User ID of the merge_proposal’s author.

access_infoobjectOptional

Access information for the merge_proposal, including creator.

Errors

422

Merge Proposals Submit Review Request Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors