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

# Generate Clean Metric Description V3

> Turn a rough metric description into a clean one suited to the agent, and return it. Usually takes under 30 seconds.



## OpenAPI

````yaml post /test_framework/v3/metrics/generate_clean_description/
openapi: 3.1.0
info:
  title: Cekura API
  version: v1
  description: >-
    Complete API documentation for the Cekura platform. This API provides
    endpoints for testing, observing, and evaluating AI voice agents — including
    managing agents, running evaluators, defining metrics, and analyzing call
    quality.
servers:
  - url: https://api.cekura.ai
security: []
paths:
  /test_framework/v3/metrics/generate_clean_description/:
    post:
      tags:
        - test_framework
      summary: Generate clean metric description
      description: >-
        Turn a rough metric description into a clean one suited to the agent,
        and return it. Usually takes under 30 seconds.
      operationId: metrics-v3-generate-clean-description
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CleanMetricDescriptionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CleanMetricDescriptionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CleanMetricDescriptionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - completed
                      - failed
                    description: >-
                      `failed` when the job could not produce its result; see
                      `error` / `errors`.
                  agent_id:
                    type: integer
                  clean_description:
                    type: string
                  error:
                    type:
                      - string
                      - 'null'
                    description: Why the job failed, when it did.
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  field_name:
                    type: array
                    items:
                      type: string
          description: ''
        '403':
          description: No access to the agent, project or metric the job runs on.
        '504':
          description: >-
            The job did not finish within 15 minutes. It may still complete in
            the background.
      security:
        - api_key: []
        - oauth2: []
        - embedded_session: []
        - supabase_session: []
components:
  schemas:
    CleanMetricDescriptionRequest:
      type: object
      properties:
        agent:
          type: integer
        metric_description:
          type: string
        eval_type:
          enum:
            - boolean
            - numeric
            - rating
            - enum
          type: string
          description: |-
            * `boolean` - boolean
            * `numeric` - numeric
            * `rating` - rating
            * `enum` - enum
          x-spec-enum-id: ae756482f906eddf
      required:
        - agent
        - eval_type
        - metric_description
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: X-CEKURA-API-KEY
      description: >-
        API Key Authentication. It should be included in the header of each
        request.
    oauth2:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth access token issued by Cekura for connected apps.
    embedded_session:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Embedded-dashboard session token. Internal.
    supabase_session:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cekura dashboard session token. Not a customer API credential.

````

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