> ## Documentation Index > Fetch the complete documentation index at: https://docs.primeintellect.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update Evaluation > Update an existing evaluation ## OpenAPI ````yaml https://api.primeintellect.ai/openapi.json put /api/v1/evaluations/{evaluation_id} openapi: 3.1.0 info: title: PI API version: 0.1.0 servers: - url: https://api.primeintellect.ai security: [] paths: /api/v1/evaluations/{evaluation_id}: put: tags: - evals summary: Update Evaluation description: Update an existing evaluation operationId: update_evaluation_api_v1_evaluations__evaluation_id__put parameters: - name: evaluation_id in: path required: true schema: type: string title: Evaluation Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEvaluationRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/UpdateEvaluationResponse' '401': description: Authorization failed '422': description: Invalid request data content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - HTTPBearer: [] components: schemas: UpdateEvaluationRequest: properties: name: anyOf: - type: string - type: 'null' title: Name description: Name of the evaluation description: anyOf: - type: string - type: 'null' title: Description description: Description of the evaluation tags: anyOf: - items: type: string type: array - type: 'null' title: Tags description: Tags for categorization metadata: anyOf: - type: object - type: 'null' title: Metadata description: Additional metadata metrics: anyOf: - type: object - type: 'null' title: Metrics description: High-level metrics summary model_name: anyOf: - type: string - type: 'null' title: Model Name description: Model name dataset: anyOf: - type: string - type: 'null' title: Dataset description: Dataset name framework: anyOf: - type: string - type: 'null' title: Framework description: Framework used task_type: anyOf: - type: string - type: 'null' title: Task Type description: Type of task inference_model: anyOf: - type: string - type: 'null' title: Inference Model description: Prime Inference model ID eval_config: anyOf: - $ref: '#/components/schemas/HostedEvalConfig' - type: 'null' description: Hosted evaluation configuration is_public: anyOf: - type: boolean - type: 'null' title: Is Public description: >- Whether the evaluation is publicly shareable by link; setting true without show_on_leaderboard keeps it off leaderboards by default show_on_leaderboard: anyOf: - type: boolean - type: 'null' title: Show On Leaderboard description: Whether this public evaluation appears on environment leaderboards type: object title: UpdateEvaluationRequest description: Request to update an existing evaluation UpdateEvaluationResponse: properties: evaluation_id: type: string title: Evaluation Id name: type: string title: Name status: $ref: '#/components/schemas/EvaluationStatus' updated_at: type: string format: date-time title: Updated At type: object required: - evaluation_id - name - status - updated_at title: UpdateEvaluationResponse description: Response after updating an evaluation ErrorResponse: properties: errors: items: $ref: '#/components/schemas/ErrorDetail' type: array title: Errors type: object required: - errors title: ErrorResponse HostedEvalConfig: properties: num_examples: type: integer maximum: 9007199254740991 minimum: -1 title: Num Examples description: Number of examples to evaluate (-1 for all) rollouts_per_example: type: integer maximum: 2048 minimum: 1 title: Rollouts Per Example description: Rollouts per example env_args: anyOf: - type: object - type: 'null' title: Env Args description: Optional environment arguments to pass to the evaluation allow_sandbox_access: anyOf: - type: boolean - type: 'null' title: Allow Sandbox Access description: Allow sandbox read/write access default: false allow_instances_access: anyOf: - type: boolean - type: 'null' title: Allow Instances Access description: Allow instance creation and management access default: false allow_tunnel_access: anyOf: - type: boolean - type: 'null' title: Allow Tunnel Access description: Allow tunnel creation and management access default: false timeout_minutes: anyOf: - type: integer maximum: 1440 minimum: 120 - type: 'null' title: Timeout Minutes description: >- Custom timeout in minutes for the hosted eval run (default: 1440 = 24 hours, min: 120, max: 1440) custom_secrets: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Custom Secrets description: >- Custom secrets to set in the evaluation sandbox (e.g., API keys, tokens) sampling_args: anyOf: - type: object - type: 'null' title: Sampling Args description: >- Optional sampling arguments forwarded to `prime eval run --sampling-args` max_concurrent: anyOf: - type: integer maximum: 9007199254740991 minimum: 1 - type: 'null' title: Max Concurrent description: >- Optional max concurrency forwarded to `prime eval run --max-concurrent` max_retries: anyOf: - type: integer maximum: 9007199254740991 minimum: 0 - type: 'null' title: Max Retries description: Optional max retries forwarded to `prime eval run --max-retries` state_columns: anyOf: - items: type: string type: array - type: 'null' title: State Columns description: Optional state columns forwarded to `prime eval run --state-columns` independent_scoring: anyOf: - type: boolean - type: 'null' title: Independent Scoring description: Forward `--independent-scoring` to the hosted eval runner default: false verbose: anyOf: - type: boolean - type: 'null' title: Verbose description: Forward `--verbose` to the hosted eval runner default: false headers: anyOf: - items: type: string type: array - type: 'null' title: Headers description: Optional repeated headers forwarded to `prime eval run --header` extra_env_kwargs: anyOf: - type: object - type: 'null' title: Extra Env Kwargs description: >- Optional environment constructor kwargs forwarded to `prime eval run --extra-env-kwargs` api_client_type: anyOf: - type: string - type: 'null' title: Api Client Type description: >- Optional API client type forwarded to `prime eval run --api-client-type` api_base_url: anyOf: - type: string - type: 'null' title: Api Base Url description: >- Optional inference base URL forwarded to `prime eval run --api-base-url` api_key_var: anyOf: - type: string - type: 'null' title: Api Key Var description: Optional API key env var forwarded to `prime eval run --api-key-var` type: object required: - num_examples - rollouts_per_example title: HostedEvalConfig description: Hosted evaluation configuration EvaluationStatus: type: string enum: - PENDING - RUNNING - PROCESSING - COMPLETED - FAILED - TIMEOUT - CANCELLED title: EvaluationStatus description: Evaluation status enum ErrorDetail: properties: param: type: string title: Param details: type: string title: Details type: object required: - param - details title: ErrorDetail securitySchemes: HTTPBearer: type: http scheme: bearer ````