REretellai

GET /get-test-case-definition/{test_case_definition_id}

Changed on

Get a test case definition by ID

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Path parameters

test_case_definition_idstring required

ID of the test case definition to retrieve

Response

Test case definition retrieved successfully

namestring required

Name of the test case definition

user_promptstring required

User prompt to simulate in the test case

metricsstring[] required

Array of metric names to evaluate

dynamic_variablesobject required

Dynamic variables to inject into the response engine

llm_model'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'gpt-5.6-terra' | 'gpt-5.6-luna' | 'gpt-6-astra' | 'gpt-6-sol' | 'gpt-6.1-sol' | 'gpt-6.1-terra' | 'gpt-6-luna' | 'claude-4.6-sonnet' | 'claude-5-opus' | 'claude-5.5-opus' | 'claude-5-sonnet' | 'claude-5.5-sonnet' | 'claude-5.5-haiku' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | 'gemini-3.5-flash' | 'gemini-3.5-flash-lite' | 'gemini-3.6-flash' | 'gemini-3.7-flash' | 'gemini-3.8-flash' | 'gemini-4-argon' required

Available LLM models for agents.

test_case_definition_idstring required

Unique identifier for the test case definition

type'simulation' required

Type of test case definition

creation_timestampinteger required

Timestamp when the test case definition was created (milliseconds since epoch)

user_modified_timestampinteger required

Timestamp when the test case definition was last modified (milliseconds since epoch)

Changes

  • 6e88894224e1Revision changes
    • warning

      added the new gpt-6.1-terra enum value to the //// response property for the response status

  • ca41f0dbb297Revision changes
    • breaking

      added subschema #1 subschema #2 to the ////// response property oneOf list for the response status

    • warning

      added the new claude-5-opus enum value to the //// response property for the response status

    • warning

      added the new claude-5-sonnet enum value to the //// response property for the response status

    • warning

      added the new claude-5.5-haiku enum value to the //// response property for the response status

    • warning

      added the new claude-5.5-opus enum value to the //// response property for the response status

    • warning

      added the new claude-5.5-sonnet enum value to the //// response property for the response status

    • warning

      added the new gemini-3.5-flash enum value to the //// response property for the response status

    • warning

      added the new gemini-3.5-flash-lite enum value to the //// response property for the response status

    • warning

      added the new gemini-3.6-flash enum value to the //// response property for the response status

    • warning

      added the new gemini-3.7-flash enum value to the //// response property for the response status

    • warning

      added the new gemini-3.8-flash enum value to the //// response property for the response status

    • warning

      added the new gemini-4-argon enum value to the //// response property for the response status

    • warning

      added the new gpt-5.6-luna enum value to the //// response property for the response status

    • warning

      added the new gpt-5.6-terra enum value to the //// response property for the response status

    • warning

      added the new gpt-6-astra enum value to the //// response property for the response status

    • warning

      added the new gpt-6-luna enum value to the //// response property for the response status

    • warning

      added the new gpt-6-sol enum value to the //// response property for the response status

    • warning

      added the new gpt-6.1-sol enum value to the //// response property for the response status

    • info

      removed the claude-4.5-sonnet enum value from the //// response property for the response status

    • info

      removed the gemini-2.5-flash-lite enum value from the //// response property for the response status

    • info

      removed the gpt-4.1-nano enum value from the //// response property for the response status

    • info

      removed subschema #1 subschema #2 from the ////// response property oneOf list for the response status