Sign in
Agents Platform

Create A Merge Proposal

Record a request to merge a source branch into a target branch. Anyone with edit access can open one; merging it later is gated on write access to the target branch, so this is how a change reaches a protected branch the author cannot merge into themselves.

post/v1/convai/agents/{agent_id}/merge-proposals

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.

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.

Request body

source_branch_idstring required

Branch whose changes should be merged.

target_branch_idstring required

Branch that should receive the changes.

titlestring required

Short title for the merge_proposal.

descriptionstring

Optional longer description for reviewers.

requested_reviewer_user_idsstring[] nullable

User IDs to request a review from.

triage_ticket_idstring nullable

Triage ticket of this agent that the merge_proposal resolves. Merging it resolves the ticket if still open.

Response

Successful Response

created_merge_proposal_idstring required

ID of the created merge_proposal

Changes

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