> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryvox.co/llms.txt
> Use this file to discover all available pages before exploring further.

# 시나리오 테스트 조회

> 시나리오 테스트의 현재 정의를 돌려줍니다. 지난 실행에 쓴 정의가 아니라 지금 저장된 정의입니다.



## OpenAPI

````yaml /api-reference/v3/openapi.json get /evals/scenario/{test_id}
openapi: 3.1.0
info:
  title: vox.ai API
  description: >
    vox.ai API v3


    ### v3 공개 계약 규칙


    - 인증은 `Authorization: Bearer <token>` 헤더를 사용합니다. 워크스페이스 API 키를 Bearer 토큰으로
    전달합니다.

    - 요청과 응답 필드는 기본적으로 `snake_case`를 사용합니다.

    - `agent.data`는 에이전트 레지스트리와 호환되어야 하므로 `callSettings`, `toolIds`,
    `builtInTools`, `presetDynamicVariables` 같은 camelCase 필드를 유지합니다.

    - `_at`으로 끝나는 타임스탬프는 unix milliseconds입니다. 일부 입력값은 호환성을 위해 10~11자리 unix
    seconds도 허용하고 milliseconds로 정규화합니다.

    - 대량 발신 통화 가능 시간은 분 단위 정수(`start_min` / `end_min`)를 사용합니다. 알림 스케줄은 `HH:MM`
    문자열(`start_time` / `end_time`)을 사용합니다.

    - 응답 객체 자신의 식별자는 `id`입니다. 다른 리소스를 참조하는 필드와 path parameter는 `agent_id`,
    `call_id`, `telephone_line_id`처럼 명시적인 이름을 사용합니다.

    - 실패 응답은 `{ "error": { "code", "message", "details" } }` 형태입니다. 가능한 경우
    `details.field`, `details.reason`, `details.allowed_values`를 함께 제공합니다.
  version: 3.0.0
servers:
  - url: https://client-api.tryvox.co/v3
    description: 운영
security: []
paths:
  /evals/scenario/{test_id}:
    get:
      tags:
        - Evals
      summary: 시나리오 테스트 조회
      description: 시나리오 테스트의 현재 정의를 돌려줍니다. 지난 실행에 쓴 정의가 아니라 지금 저장된 정의입니다.
      operationId: getScenarioTest
      parameters:
        - name: test_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: 시나리오 테스트 id입니다. GET /v3/evals/scenario 응답의 id를 사용합니다.
            title: Test Id
          description: 시나리오 테스트 id입니다. GET /v3/evals/scenario 응답의 id를 사용합니다.
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioTestResponse'
              example:
                id: 0f9c2b1e-3d4a-4b5c-8d6e-7f8091a2b3c4
                name: 예약 취소
                description: 취소를 원하는 고객과 끝까지 통화합니다.
                created_at: 1761960000000
                user_prompt: 다음 주 예약을 취소하려는 고객입니다. 예약번호를 물으면 A1234라고 답합니다.
                rubric: 예약번호를 확인하고 취소를 마친 뒤 취소 사실을 알려 준다.
                max_turns: 15
                dynamic_variables: null
                tool_mocks: null
                metadata:
                  team: cs
        '400':
          description: 요청 검증 오류
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validationError:
                  summary: 요청 검증 오류
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: Request validation failed.
                      details:
                        field: name
                        reason: must not be blank
        '401':
          description: 인증이 필요합니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized:
                  summary: Bearer 토큰 누락 또는 오류
                  value:
                    error:
                      code: UNAUTHORIZED
                      message: Authentication is required.
                      details: {}
        '403':
          description: 권한이 없습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden:
                  summary: 권한이 없습니다.
                  value:
                    error:
                      code: FORBIDDEN
                      message: Permission denied.
                      details: {}
        '404':
          description: 리소스를 찾을 수 없습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                notFound:
                  summary: 리소스를 찾을 수 없습니다.
                  value:
                    error:
                      code: RESOURCE_NOT_FOUND
                      message: Resource not found.
                      details:
                        resource: agent
        '409':
          description: 충돌이 발생했습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                conflict:
                  summary: 상태 충돌이 발생했습니다.
                  value:
                    error:
                      code: CONFLICT
                      message: The requested operation conflicts with current state.
                      details:
                        current_status: draft
        '429':
          description: >-
            요청 한도를 초과했습니다. API 키 트래픽은 기본값으로 워크스페이스당 초당 5회·분당 120회, Supabase JWT
            트래픽은 기본값으로 사용자당 초당 10회·분당 240회로 제한되며, 워크스페이스 대시보드에는 기본 분당 2,400회의
            백스톱 한도가 적용됩니다. 한도는 운영자가 조정할 수 있고, 초과한 버킷의 실제 한도와 윈도우는 429 응답의
            X-RateLimit-Limit·X-RateLimit-Window 헤더로 알려 줍니다. 개별 경로 자체 리미터가 만든
            429 응답에는 이 헤더가 없을 수 있습니다.
          headers:
            Retry-After:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우가 초기화될 때까지 남은 시간입니다. 단위는
                초입니다. 개별 경로 자체 리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우의 최대 요청 수입니다. 개별 경로 자체
                리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Window:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우의 길이입니다. 단위는 초입니다. 개별 경로
                자체 리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                rateLimited:
                  summary: 요청 한도를 초과했습니다.
                  value:
                    error:
                      code: RATE_LIMIT_EXCEEDED
                      message: Too many requests.
                      details:
                        limit: 10
                        window_seconds: 1
                        scope: user
        '500':
          description: 서버 내부 오류가 발생했습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internalError:
                  summary: 서버 내부 오류가 발생했습니다.
                  value:
                    error:
                      code: INTERNAL_ERROR
                      message: Internal server error.
                      details: {}
        '503':
          description: 서비스를 일시적으로 사용할 수 없습니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                serviceUnavailable:
                  summary: 서비스를 일시적으로 사용할 수 없습니다.
                  value:
                    error:
                      code: SERVICE_UNAVAILABLE
                      message: Service temporarily unavailable.
                      details: {}
      security:
        - BearerAuth: []
components:
  schemas:
    ScenarioTestResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: 테스트 id입니다.
        name:
          type: string
          title: Name
          description: 테스트 이름입니다.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: 테스트 설명입니다. null이면 설명이 없습니다.
        created_at:
          type: integer
          title: Created At
          description: 리소스 생성 시각입니다. unix milliseconds 형식입니다.
        user_prompt:
          type: string
          title: User Prompt
          description: AI 고객의 목표와 말투입니다.
        rubric:
          type: string
          title: Rubric
          description: 대화 전체를 판정할 기준입니다.
        max_turns:
          type: integer
          title: Max Turns
          description: 대화 길이 상한입니다. 고객과 에이전트의 메시지를 각각 한 번으로 세며, 마지막 응답을 마치려고 한 번 넘길 수 있습니다.
        dynamic_variables:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Dynamic Variables
          description: 실행할 때 에이전트에 넣을 동적 변수입니다.
        tool_mocks:
          anyOf:
            - items:
                oneOf:
                  - $ref: '#/components/schemas/EvalApiToolMock'
                  - $ref: '#/components/schemas/EvalMcpToolMock'
                  - $ref: '#/components/schemas/EvalFlowApiToolMock'
                discriminator:
                  propertyName: type
                  mapping:
                    api: '#/components/schemas/EvalApiToolMock'
                    flow_api: '#/components/schemas/EvalFlowApiToolMock'
                    mcp: '#/components/schemas/EvalMcpToolMock'
              type: array
            - type: 'null'
          title: Tool Mocks
          description: >-
            실행할 때 실제 도구 대신 돌려줄 도구 응답입니다. 같은 도구나 Flow 노드는 한 번만 지정합니다. null이면 정해 둔
            응답이 없습니다.
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
          description: 테스트에 붙여 두는 사용자 정의 정보입니다. 실행에는 쓰이지 않습니다.
      type: object
      required:
        - id
        - name
        - description
        - created_at
        - user_prompt
        - rubric
        - max_turns
        - dynamic_variables
        - tool_mocks
        - metadata
      title: ScenarioTestResponse
    ErrorResponse:
      type: object
      required:
        - error
      title: ErrorResponse
      description: 모든 실패 응답에서 사용하는 v3 error envelope입니다.
      examples:
        - error:
            code: VALIDATION_ERROR
            message: Request validation failed.
            details:
              field: name
              reason: must not be blank
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: 오류 payload입니다.
    EvalApiToolMock:
      properties:
        type:
          type: string
          const: api
          title: Type
          description: 응답을 정해 둘 API 도구입니다.
        tool_id:
          type: string
          format: uuid
          title: Tool Id
          description: 응답을 정해 둘 API 도구 id입니다. GET /v3/tools 응답의 id를 사용합니다.
        response:
          oneOf:
            - $ref: '#/components/schemas/EvalToolMockJsonResponse'
            - $ref: '#/components/schemas/EvalToolMockTextResponse'
          title: Response
          description: 도구 대신 돌려줄 응답입니다. 생략하면 빈 JSON 객체 `{}`를 돌려주며, null은 쓸 수 없습니다.
          discriminator:
            propertyName: type
            mapping:
              json: '#/components/schemas/EvalToolMockJsonResponse'
              text: '#/components/schemas/EvalToolMockTextResponse'
      additionalProperties: false
      type: object
      required:
        - type
        - tool_id
      title: EvalApiToolMock
    EvalMcpToolMock:
      properties:
        type:
          type: string
          const: mcp
          title: Type
          description: 응답을 정해 둘 MCP 서버입니다.
        tool_id:
          type: string
          format: uuid
          title: Tool Id
          description: 응답을 정해 둘 MCP 연결 도구 id입니다. GET /v3/tools 응답의 id를 사용합니다.
        tools:
          items:
            $ref: '#/components/schemas/EvalMcpTool'
          type: array
          title: Tools
          description: 이 MCP 서버에서 쓸 도구 목록입니다. 도구 이름은 서로 달라야 합니다.
      additionalProperties: false
      type: object
      required:
        - type
        - tool_id
        - tools
      title: EvalMcpToolMock
    EvalFlowApiToolMock:
      properties:
        type:
          type: string
          const: flow_api
          title: Type
          description: 응답을 정해 둘 Flow API 노드입니다.
        agent_id:
          type: string
          format: uuid
          title: Agent Id
          description: 에이전트 UUID입니다.
        node_id:
          type: string
          minLength: 1
          title: Node Id
          description: 응답을 정해 둘 Flow API 노드 id입니다.
        response:
          oneOf:
            - $ref: '#/components/schemas/EvalToolMockJsonResponse'
            - $ref: '#/components/schemas/EvalToolMockTextResponse'
          title: Response
          description: 도구 대신 돌려줄 응답입니다. 생략하면 빈 JSON 객체 `{}`를 돌려주며, null은 쓸 수 없습니다.
          discriminator:
            propertyName: type
            mapping:
              json: '#/components/schemas/EvalToolMockJsonResponse'
              text: '#/components/schemas/EvalToolMockTextResponse'
      additionalProperties: false
      type: object
      required:
        - type
        - agent_id
        - node_id
      title: EvalFlowApiToolMock
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - details
      title: ErrorDetail
      description: 기계가 읽을 수 있는 v3 오류 상세 정보입니다.
      examples:
        - code: VALIDATION_ERROR
          message: Request validation failed.
          details:
            field: name
            reason: must not be blank
      properties:
        code:
          type: string
          title: Code
          description: 기계가 읽을 수 있는 오류 code입니다. message parsing 대신 이 값을 사용합니다.
          examples:
            - VALIDATION_ERROR
        message:
          type: string
          title: Message
          description: 사용자에게 표시할 수 있는 오류 메시지입니다. 프로그램 처리는 `code`를 사용합니다.
          examples:
            - Request validation failed.
        details:
          type: object
          title: Details
          additionalProperties: true
          description: 구조화된 context입니다. 주로 `field`, `reason`, `allowed_values`를 포함합니다.
    EvalToolMockJsonResponse:
      properties:
        type:
          type: string
          const: json
          title: Type
          description: JSON 응답입니다.
        value:
          title: Value
          description: 도구 대신 돌려줄 JSON 값입니다. null도 쓸 수 있습니다.
      additionalProperties: false
      type: object
      required:
        - type
        - value
      title: EvalToolMockJsonResponse
    EvalToolMockTextResponse:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: 문자열 응답입니다.
        value:
          type: string
          title: Value
          description: 도구 대신 돌려줄 문자열입니다.
      additionalProperties: false
      type: object
      required:
        - type
        - value
      title: EvalToolMockTextResponse
    EvalMcpTool:
      properties:
        name:
          type: string
          minLength: 1
          title: Name
          description: 응답을 정해 둘 MCP 도구 이름입니다.
        description:
          type: string
          title: Description
          description: 에이전트에 보여 줄 도구 설명입니다. 생략할 수 있으며 null은 쓸 수 없습니다.
        input_schema:
          additionalProperties: true
          type: object
          title: Input Schema
          description: 도구 입력의 JSON Schema입니다. `type`은 `object`여야 합니다.
        response:
          oneOf:
            - $ref: '#/components/schemas/EvalToolMockJsonResponse'
            - $ref: '#/components/schemas/EvalToolMockTextResponse'
          title: Response
          description: 도구 대신 돌려줄 응답입니다. 생략하면 빈 JSON 객체 `{}`를 돌려주며, null은 쓸 수 없습니다.
          discriminator:
            propertyName: type
            mapping:
              json: '#/components/schemas/EvalToolMockJsonResponse'
              text: '#/components/schemas/EvalToolMockTextResponse'
      additionalProperties: false
      type: object
      required:
        - name
        - input_schema
      title: EvalMcpTool
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Organization API key
      description: '워크스페이스 API 키를 `Authorization: Bearer <token>` 형식으로 보냅니다.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.