Agents Platform

Create Procedure

Changed on

Create a new procedure for the agent on a branch.

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

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/agents/{agent_id}/branches/{branch_id}/procedures
  • Auth
    none declared

Path parameters

agent_idstring required

Agent ID to get the procedure draft from

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz
branch_idstring required

Branch ID to get the procedure draft from

Example:agtbranch_0901k4aafjxxfxt93gd841r7tv5t

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

Procedure name

contentstring

Initial procedure content

type'free_form' | 'deterministic' | 'folder'
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. Omit this field (or send null) to keep the stored trigger, which is empty on create. Send "" to clear it. description is accepted as an alias.

folder_parent_idstring nullable

Procedure ID of the folder to create this procedure in, or null for root.

Response

Successful Response

procedure_idstring required

ID of the created procedure

Example response

{
  "procedure_id": "agtprc_6qbpwdq8n01bxhk44bgjy6f10ck3"
}

Changes

  • 1eeefe174b1dRevision changes
    • info

      added the new optional request property /

    • info

      added the new folder enum value to the request property /

  • 72c54eba117eRevision changes
    • info

      endpoint added