Skip to main content
GET
Preview Rebased Configuration

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id
string
required

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

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

branch_id
string
required

Unique identifier for the source branch to merge from.

Example:

"agtbrch_8901k4t9z5defmb8vh3e9361y7nj"

Response

Successful Response

agent_id
string
required

The ID of the agent

name
string
required

The name of the agent

conversation_config
ConversationalConfigAPIModel · object
required

The conversation configuration of the agent

metadata
AgentMetadataResponseModel · object
required

The metadata of the agent

platform_settings
AgentPlatformSettingsResponseModel · object

The platform settings of the agent

phone_numbers
(GetPhoneNumberTwilioResponseModel · object | GetPhoneNumberExotelResponseModel · object | GetPhoneNumberSIPTrunkResponseModel · object)[]

The phone numbers of the agent

Example:
whatsapp_accounts
GetWhatsAppAccountResponse · object[]

WhatsApp accounts assigned to the agent

workflow
AgentWorkflowResponseModel · object

The workflow of the agent

Example:
access_info
ResourceAccessInfo · object | null

The access information of the agent for the user

Example:
tags
string[]

Agent tags used to categorize the agent

version_id
string | null

The ID of the version the agent is on

branch_id
string | null

The ID of the branch the agent is on

main_branch_id
string | null

The ID of the main branch for this agent

overridden_fields
string[]

Dot-paths of config fields where both branches modified the same field relative to their common ancestor (conflicts). Present regardless of which side wins the conflict.

source_identical_to_target
boolean
default:false

True when the merge/rebase would be a no-op, i.e. the merged result is identical to the source branch tip. The rebase endpoint rejects in this case.