v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

Agents Platform

Get Procedure

Retrieve a procedure at a specific version or the current branch HEAD.

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

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

Query parameters

version_idstring nullable

The version ID to retrieve. If omitted, returns the version at branch HEAD.

Example:agtprcv_7rbqxer9o12cyxi55ckw6sgz1dl4

The version ID to retrieve. If omitted, returns the version at branch HEAD.

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.

Response

Successful Response

procedure_idstring required

Procedure ID

version_idstring nullable

Version ID of a version of the procedure. None for a procedure never versioned.

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",
  "version_id": "agtprcv_7rbqxer9o12cyxi55ckw6sgz1dl4"
}