v5

OpenAPI 3.1.02026-08-043621,4011.8 MB

Agents Platform

Update Procedure Draft

Create or update user's draft for a procedure

patch/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures/{procedure_id}/draft

Path parameters

agent_idstring required

Agent ID to get the procedure draft from

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

Agent ID to get the procedure draft from

branch_idstring required

Branch ID to get the procedure draft from

Example:agtbranch_0901k4aafjxxfxt93gd841r7tv5t

Branch ID to get the procedure draft from

procedure_idstring required

The procedure ID

Example:agtprc_6qbpwdq8n01bxhk44bgjy6f10ck3

The procedure ID

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.

Request body

namestring required

Procedure name

contentstring required

Procedure content

type'free_form' | 'deterministic' required

triggerstring nullable

When the agent should use this procedure. Empty string means this is a sub-procedure that should only start when another procedure references it. If omitted or null, the trigger is derived from the content instead. Also accepts description as an alias.

Response

Successful Response

procedure_idstring required

Procedure ID

namestring required

Procedure name

contentstring required

Procedure content

type'free_form' | 'deterministic'

triggerstring

When the agent should use this procedure. Empty string means this is a sub-procedure that should only start when another procedure references it.

Example response

{
  "content": "# Customer Support Procedure\n\n1. Greet the customer...",
  "name": "Customer Support Procedure",
  "procedure_id": "agtprc_6qbpwdq8n01bxhk44bgjy6f10ck3",
  "trigger": "When the customer asks for support",
  "type": "free_form"
}