Skip to main content
GET
Get agent setup session

Authorizations

x-api-key
string
header
required

Path Parameters

agentId
string<uuid>
required

UUID of the agent to retrieve the session for

Response

Agent setup session retrieved successfully.

agentIntroMessage
string
required

Introduction message describing the agent and its capabilities.

Example:

"I am a customer support agent designed to help users with their inquiries."

processInstructions
string
required

Instructions outlining the process and workflow the agent follows.

Example:

"First, I will gather information about your issue. Then, I will provide relevant solutions."

agentSop
string
required

Standard Operating Procedures (SOP) that define how the agent handles tasks.

Example:

"Step 1: Greet the user. Step 2: Identify the issue. Step 3: Provide resolution."

status
string
required

Current status of the agent setup process.

Example:

"in_progress"

step
string
required

Current step in the agent setup workflow.

Example:

"GRAPH_GENERATION"

generatedGraph
object

Generated workflow graph for the agent, including nodes and their connections.