Update test invocation

PATCH

/v1/convai/test-invocations/:test_invocation_id

PATCH

/v1/convai/test-invocations/:test_invocation_id

curl -X PATCH https://api.elevenlabs.io/v1/convai/test-invocations/test_invocation_id \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string"
}'

{
  "id": "string",
  "test_runs": [
    {
      "test_run_id": "string",
      "test_invocation_id": "string",
      "agent_id": "string",
      "status": "pending",
      "test_id": "string",
      "test_info": {
        "type": "llm",
        "chat_history": [
          {
            "role": "user",
            "time_in_call_secs": 1,
            "agent_metadata": {
              "agent_id": "string",
              "branch_id": "string",
              "workflow_node_id": "string",
              "version_id": "string"
            },
            "message": "string",
            "multivoice_message": {
              "parts": [
                {
                  "text": "string",
                  "voice_label": "string",
                  "time_in_call_secs": 1
                }
              ]
            },
            "tool_calls": [
              {
                "request_id": "string",
                "tool_name": "string",
                "params_as_json": "string",
                "tool_has_been_called": true,
                "type": "system",
                "tool_id": "string",
                "tool_details": {
                  "type": "webhook",
                  "method": "string",
                  "url": "string",
                  "body": "string",
                  "headers": {},
                  "path_params": {},
                  "query_params": {}
                }
              }
            ],
            "tool_results": [
              {
                "dynamic_variable_updates": [
                  {
                    "new_value": "string",
                    "old_value": "string",
                    "tool_name": "string",
                    "tool_request_id": "string",
                    "updated_at": 1.1,
                    "variable_name": "string"
                  }
                ],
                "error_type": "",
                "is_blocked": false,
                "is_error": true,
                "raw_error_message": "",
                "request_id": "string",
                "result_value": "string",
                "tool_has_been_called": true,
                "tool_latency_secs": 0,
                "tool_name": "string",
                "type": "client"
              }
            ],
            "feedback": {
              "score": "like",
              "time_in_call_secs": 1
            },
            "llm_override": "string",
            "producing_llm": "string",
            "conversation_turn_metrics": {
              "metrics": {},
              "convai_asr_provider": "string",
              "convai_tts_model": "string",
              "convai_tts_cascade": "string",
              "voice_id": "string"
            },
            "rag_retrieval_info": {
              "chunks": [
                {
                  "document_id": "string",
                  "chunk_id": "string",
                  "vector_distance": 1.1
                }
              ],
              "embedding_model": "e5_mistral_7b_instruct",
              "retrieval_query": "string",
              "rag_latency_secs": 1.1,
              "used_chunk_ids": [
                "string"
              ]
            },
            "llm_usage": {
              "model_usage": {}
            },
            "interrupted": false,
            "ignored_as_backchannel": false,
            "platform_event": "user_turn_timeout",
            "original_message": "string",
            "reasoning": [
              {
                "summary": "string",
                "provider_redact": false
              }
            ],
            "source_medium": "audio",
            "source_event_id": 1,
            "used_static_kb_document_ids": [
              "string"
            ],
            "user_identifier": "string",
            "id": "string",
            "triggered_guardrails": [
              {
                "guardrail_type": "custom",
                "guardrail_name": "string"
              }
            ]
          }
        ],
        "conversation_initiation_source": "unknown",
        "dynamic_variables": {},
        "environment": "string",
        "failure_examples": [
          {
            "response": "string",
            "type": "string"
          }
        ],
        "from_conversation_metadata": {
          "conversation_id": "string",
          "agent_id": "string",
          "branch_id": "string",
          "workflow_node_id": "string",
          "original_agent_reply": [
            {
              "role": "user",
              "time_in_call_secs": 1,
              "agent_metadata": {
                "agent_id": "string",
                "branch_id": "string",
                "workflow_node_id": "string",
                "version_id": "string"
              },
              "message": "string",
              "multivoice_message": {
                "parts": [
                  {
                    "text": "string",
                    "voice_label": "string",
                    "time_in_call_secs": 1
                  }
                ]
              },
              "tool_calls": [
                {
                  "request_id": "string",
                  "tool_name": "string",
                  "params_as_json": "string",
                  "tool_has_been_called": true,
                  "type": "system",
                  "tool_id": "string",
                  "tool_details": {
                    "type": "api_integration_webhook",
                    "credential_id": "",
                    "integration_connection_id": "",
                    "integration_id": "",
                    "webhook_details": {
                      "method": {},
                      "url": {},
                      "headers": {},
                      "path_params": {},
                      "query_params": {},
                      "body": {},
                      "type": {}
                    }
                  }
                }
              ],
              "tool_results": [
                {
                  "dynamic_variable_updates": [
                    {
                      "new_value": "string",
                      "old_value": "string",
                      "tool_name": "string",
                      "tool_request_id": "string",
                      "updated_at": 1.1,
                      "variable_name": "string"
                    }
                  ],
                  "error_type": "",
                  "is_blocked": false,
                  "is_error": true,
                  "raw_error_message": "",
                  "request_id": "string",
                  "result_value": "string",
                  "tool_has_been_called": true,
                  "tool_latency_secs": 0,
                  "tool_name": "string",
                  "type": "client"
                }
              ],
              "feedback": {
                "score": "like",
                "time_in_call_secs": 1
              },
              "llm_override": "string",
              "producing_llm": "string",
              "conversation_turn_metrics": {
                "metrics": {},
                "convai_asr_provider": "string",
                "convai_tts_model": "string",
                "convai_tts_cascade": "string",
                "voice_id": "string"
              },
              "rag_retrieval_info": {
                "chunks": [
                  {
                    "document_id": "string",
                    "chunk_id": "string",
                    "vector_distance": 1.1
                  }
                ],
                "embedding_model": "e5_mistral_7b_instruct",
                "retrieval_query": "string",
                "rag_latency_secs": 1.1,
                "used_chunk_ids": [
                  "string"
                ]
              },
              "llm_usage": {
                "model_usage": {}
              },
              "interrupted": false,
              "ignored_as_backchannel": false,
              "platform_event": "user_turn_timeout",
              "original_message": "string",
              "reasoning": [
                {
                  "summary": "string",
                  "provider_redact": false
                }
              ],
              "source_medium": "audio",
              "source_event_id": 1,
              "used_static_kb_document_ids": [
                "string"
              ],
              "user_identifier": "string",
              "id": "string",
              "triggered_guardrails": [
                {
                  "guardrail_type": "custom",
                  "guardrail_name": "string"
                }
              ]
            }
          ]
        },
        "success_condition": "",
        "success_examples": [
          {
            "response": "string",
            "type": "string"
          }
        ]
      },
      "branch_id": "string",
      "version_id": "string",
      "ran_against_draft": false,
      "workflow_node_id": "string",
      "agent_responses": [
        {
          "role": "user",
          "time_in_call_secs": 1,
          "agent_metadata": {
            "agent_id": "string",
            "branch_id": "string",
            "workflow_node_id": "string",
            "version_id": "string"
          },
          "message": "string",
          "multivoice_message": {
            "parts": [
              {
                "text": "string",
                "voice_label": "string",
                "time_in_call_secs": 1
              }
            ]
          },
          "tool_calls": [
            {
              "request_id": "string",
              "tool_name": "string",
              "params_as_json": "string",
              "tool_has_been_called": true,
              "type": "system",
              "tool_id": "string",
              "tool_details": {
                "type": "webhook",
                "method": "string",
                "url": "string",
                "body": "string",
                "headers": {},
                "path_params": {},
                "query_params": {}
              }
            }
          ],
          "tool_results": [
            {
              "dynamic_variable_updates": [
                {
                  "new_value": "string",
                  "old_value": "string",
                  "tool_name": "string",
                  "tool_request_id": "string",
                  "updated_at": 1.1,
                  "variable_name": "string"
                }
              ],
              "error_type": "",
              "is_blocked": false,
              "is_error": true,
              "raw_error_message": "",
              "request_id": "string",
              "result_value": "string",
              "tool_has_been_called": true,
              "tool_latency_secs": 0,
              "tool_name": "string",
              "type": "client"
            }
          ],
          "feedback": {
            "score": "like",
            "time_in_call_secs": 1
          },
          "llm_override": "string",
          "producing_llm": "string",
          "conversation_turn_metrics": {
            "metrics": {},
            "convai_asr_provider": "string",
            "convai_tts_model": "string",
            "convai_tts_cascade": "string",
            "voice_id": "string"
          },
          "rag_retrieval_info": {
            "chunks": [
              {
                "document_id": "string",
                "chunk_id": "string",
                "vector_distance": 1.1
              }
            ],
            "embedding_model": "e5_mistral_7b_instruct",
            "retrieval_query": "string",
            "rag_latency_secs": 1.1,
            "used_chunk_ids": [
              "string"
            ]
          },
          "llm_usage": {
            "model_usage": {}
          },
          "interrupted": false,
          "ignored_as_backchannel": false,
          "platform_event": "user_turn_timeout",
          "original_message": "string",
          "reasoning": [
            {
              "summary": "string",
              "provider_redact": false
            }
          ],
          "source_medium": "audio",
          "source_event_id": 1,
          "used_static_kb_document_ids": [
            "string"
          ],
          "user_identifier": "string",
          "id": "string",
          "triggered_guardrails": [
            {
              "guardrail_type": "custom",
              "guardrail_name": "string"
            }
          ]
        }
      ],
      "test_name": "Unknown Test",
      "condition_result": {
        "result": "success",
        "rationale": {
          "messages": [
            "string"
          ],
          "summary": ""
        }
      },
      "last_updated_at_unix": 1,
      "metadata": {
        "workspace_id": "string",
        "test_name": "string",
        "ran_by_user_email": "string",
        "test_type": "llm"
      },
      "root_folder_id": "string",
      "root_folder_name": "string",
      "environment": "string",
      "credits_used": 1,
      "charging": {
        "dev_discount": false,
        "is_burst": false,
        "tier": "string",
        "llm_usage": {
          "irreversible_generation": {
            "model_usage": {}
          },
          "initiated_generation": {
            "model_usage": {}
          }
        },
        "llm_price": 1.1,
        "llm_charge": 1,
        "call_charge": 1,
        "platform_charge": 1,
        "platform_usage": {
          "category_usage": {}
        },
        "platform_price": 1.1,
        "free_minutes_consumed": 0,
        "free_llm_dollars_consumed": 0,
        "tts_usage": {
          "primary_tts_model": "string",
          "total_audio_output_seconds": 0,
          "total_characters": 0,
          "per_voice_usage": [
            {
              "voice_id": "string",
              "audio_output_seconds": 0
            }
          ]
        },
        "asr_usage": {
          "asr_model": "string",
          "total_transcription_calls": 0,
          "total_audio_input_seconds": 0
        },
        "analysis": {
          "total": {
            "price": 0,
            "charge": 0,
            "runs": 0,
            "price_per_feature": {},
            "charge_per_feature": {}
          },
          "last_run": {
            "price": 0,
            "charge": 0,
            "price_per_feature": {},
            "charge_per_feature": {}
          }
        },
        "voice_surcharge_charge": 1
      }
    }
  ],
  "name": "string",
  "agent_id": "string",
  "branch_id": "string",
  "version_id": "string",
  "ran_against_draft": false,
  "created_at": 1,
  "folder_id": "string",
  "repeat_count": 1,
  "cancelled": false,
  "bucketing_status": "pending",
  "result_groups": [
    {
      "test_id": "string",
      "test_name": "string",
      "buckets": [
        {
          "test_run_ids": [
            "string"
          ],
          "title": "string",
          "reason": "string",
          "status": "pending"
        }
      ],
      "workflow_node_id": "string"
    }
  ]
}

Updates the user-provided name of a test invocation.

Path parameters

test_invocation_idstringRequired

The id of a test invocation. This is returned when tests are run.

Request

This endpoint expects an object.

namestring or nullRequired1-256 characters

New name for the test invocation. Set to null to restore the generated title.

Response

Successful Response

idstring

test_runslist of objects

namestring or nullOptional

The user-provided name of the test invocation, if one was set.

agent_idstring or nullOptional

branch_idstring or nullOptional

version_idstring or nullOptional

ran_against_draftbooleanOptionalDefaults to false

created_atintegerOptional

folder_idstring or nullOptional

repeat_countintegerOptionalDefaults to 1

cancelledbooleanOptionalDefaults to false

bucketing_statusenum or nullOptional

None when repeat_count==1 (no bucketing). Otherwise tracks bucketing lifecycle.

Allowed values:

result_groupslist of objectsOptional

Errors

422

Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors