Get Procedure

GET

/v1/convai/agents/:agent_id/branches/:branch_id/procedures/:procedure_id

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

agent_idstringRequis

Agent ID to get the procedure draft from

branch_idstringRequis

Branch ID to get the procedure draft from

procedure_idstringRequis

The procedure ID

version_idstringOptionnel

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

agent_version_idstringOptionnel

The agent version ID to retrieve the procedure for.

Successful Response

procedure_idstring

Procedure ID

namestring<=200 characters

Procedure name

contentstring<=50000 characters

Procedure content

version_idstringOptionnel

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

typeenumOptionnelPar défaut free_form

Procedure type

Valeurs autorisées:

triggerstringOptionnelPar défaut

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

folder_parent_idstringOptionnel

Procedure ID of the folder this procedure is placed in. None means root.

422

Procedures Get Request Unprocessable Entity Error