Sign in
Agents Platform

Get A Merge Proposal

Get a single merge_proposal.

get/v1/convai/agents/{agent_id}/merge-proposals/{merge_proposal_id}

Path parameters

agent_idstring required

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

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

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

merge_proposal_idstring required

Unique identifier for the merge_proposal.

Example:agtmprop_8901k4t9z5defmb8vh3e9361y7nj

Unique identifier for the merge_proposal.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

idstring required
agent_idstring required
source_branch_idstring required
target_branch_idstring required
source_tip_version_id_at_creationstring required
titlestring required
descriptionstring
requested_reviewer_user_idsstring[]
created_atinteger required
updated_atinteger required
author_user_idstring nullable

User ID of the merge_proposal's author.

Example response

{
  "access_info": {
    "access_source": "creator",
    "creator_email": "john.doe@example.com",
    "creator_name": "John Doe",
    "is_creator": true,
    "role": "admin"
  }
}

Changes

Changed in 1 of the 51 revisions of this API.1