Agents Platform

List Procedures

Changed on

List the procedures attached to this agent branch. By default, unpublished drafts take precedence over the latest committed version. Pass agent_version_id to list a published snapshot instead. has_draft is true when a procedure has unpublished draft changes on this branch. Procedure content is not included; use Get Procedure to read a procedure's body.

get/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

Query parameters

agent_version_idstring nullable

The agent version ID to retrieve the procedure for.

Example:agtvrsn_8901k4t9z5defmb8vh3e9361y7nj

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

Example response

{
  "procedures": [
    {
      "has_draft": false,
      "name": "Customer Support Procedure",
      "procedure_id": "agtprc_6qbpwdq8n01bxhk44bgjy6f10ck3",
      "referenced_dynamic_variables": [
        "customer_id"
      ],
      "referenced_kb_ids": [
        "kb_123"
      ],
      "referenced_procedure_ids": [
        "agtprc_other"
      ],
      "referenced_tool_ids": [
        "tool_123"
      ],
      "trigger": "When the customer asks for support",
      "type": "free_form",
      "version_id": "agtprcv_7rbqxer9o12cyxi55ckw6sgz1dl4"
    }
  ]
}

Changes

  • 1eeefe174b1dRevision changes
    • warning

      added the new folder enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • b96b80bcbb83Revision changes
    • info

      added the new optional query request parameter agent_version_id