Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

List Procedures

List the agent's procedures on a branch with their procedure_id, version_id, name, type, trigger, and has_draft. has_draft is true when a procedure has unpublished draft changes on this branch; its name/type/trigger then reflect that draft. Does not return procedure content -- use Get Procedure to read a procedure's body.

get/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures

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

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

Example response

{
  "procedures": [
    {
      "has_draft": false,
      "name": "Customer Support Procedure",
      "procedure_id": "agtprc_6qbpwdq8n01bxhk44bgjy6f10ck3",
      "trigger": "When the customer asks for support",
      "type": "free_form",
      "version_id": "agtprcv_7rbqxer9o12cyxi55ckw6sgz1dl4"
    }
  ]
}