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_idstringErforderlich

Agent ID to get the procedure draft from

branch_idstringErforderlich

Branch ID to get the procedure draft from

procedure_idstringErforderlich

The procedure ID

version_idstringOptional

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

agent_version_idstringOptional

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_idstringOptional

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

typeenumOptionalStandardwert ist free_form

Procedure type

Erlaubte Werte:

triggerstringOptionalStandardwert ist

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_idstringOptional

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

422

Procedures Get Request Unprocessable Entity Error