# Create optimization

POST http://localhost:5173/api/v1/private/optimizations
Content-Type: application/json

Create optimization

Reference: https://www.comet.com/docs/opik/reference/rest-api/optimizations/create-optimization

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Create optimization
  version: endpoint_optimizations.createOptimization
paths:
  /v1/private/optimizations:
    post:
      operationId: create-optimization
      summary: Create optimization
      description: Create optimization
      tags:
        - - subpackage_optimizations
      parameters: []
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Optimizations_createOptimization_Response_201
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Optimization_Write'
components:
  schemas:
    OptimizationWriteStatus:
      type: string
      enum:
        - value: running
        - value: completed
        - value: cancelled
        - value: initialized
        - value: error
    JsonListStringWriteOneOf1Items:
      type: object
      properties: {}
    JsonListStringWrite1:
      type: array
      items:
        $ref: '#/components/schemas/JsonListStringWriteOneOf1Items'
    JsonListString_Write:
      oneOf:
        - type: object
          additionalProperties:
            description: Any type
        - $ref: '#/components/schemas/JsonListStringWrite1'
        - type: string
    StudioMessage_Write:
      type: object
      properties:
        role:
          type: string
        content:
          type: string
      required:
        - role
        - content
    StudioPrompt_Write:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/StudioMessage_Write'
      required:
        - messages
    JsonNode_Write:
      type: object
      properties: {}
    StudioLlmModel_Write:
      type: object
      properties:
        model:
          type: string
        parameters:
          $ref: '#/components/schemas/JsonNode_Write'
      required:
        - model
    StudioMetric_Write:
      type: object
      properties:
        type:
          type: string
        parameters:
          $ref: '#/components/schemas/JsonNode_Write'
      required:
        - type
    StudioEvaluation_Write:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/StudioMetric_Write'
      required:
        - metrics
    StudioOptimizer_Write:
      type: object
      properties:
        type:
          type: string
        parameters:
          $ref: '#/components/schemas/JsonNode_Write'
      required:
        - type
    OptimizationStudioConfig_Write:
      type: object
      properties:
        dataset_name:
          type: string
        prompt:
          $ref: '#/components/schemas/StudioPrompt_Write'
        llm_model:
          $ref: '#/components/schemas/StudioLlmModel_Write'
        evaluation:
          $ref: '#/components/schemas/StudioEvaluation_Write'
        optimizer:
          $ref: '#/components/schemas/StudioOptimizer_Write'
      required:
        - dataset_name
        - prompt
        - llm_model
        - evaluation
        - optimizer
    Optimization_Write:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        dataset_name:
          type: string
        objective_name:
          type: string
        status:
          $ref: '#/components/schemas/OptimizationWriteStatus'
        metadata:
          $ref: '#/components/schemas/JsonListString_Write'
        studio_config:
          $ref: '#/components/schemas/OptimizationStudioConfig_Write'
        last_updated_at:
          type: string
          format: date-time
      required:
        - dataset_name
        - objective_name
        - status
    Optimizations_createOptimization_Response_201:
      type: object
      properties: {}

```

## SDK Code Examples

```python
import requests

url = "http://localhost:5173/api/v1/private/optimizations"

payload = {
    "dataset_name": "string",
    "objective_name": "string",
    "status": "running"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/optimizations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"dataset_name":"string","objective_name":"string","status":"running"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/optimizations"

	payload := strings.NewReader("{\n  \"dataset_name\": \"string\",\n  \"objective_name\": \"string\",\n  \"status\": \"running\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/optimizations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset_name\": \"string\",\n  \"objective_name\": \"string\",\n  \"status\": \"running\"\n}"

response = http.request(request)
puts response.read_body
```

```java
HttpResponse<String> response = Unirest.post("http://localhost:5173/api/v1/private/optimizations")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_name\": \"string\",\n  \"objective_name\": \"string\",\n  \"status\": \"running\"\n}")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:5173/api/v1/private/optimizations', [
  'body' => '{
  "dataset_name": "string",
  "objective_name": "string",
  "status": "running"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
var client = new RestClient("http://localhost:5173/api/v1/private/optimizations");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"dataset_name\": \"string\",\n  \"objective_name\": \"string\",\n  \"status\": \"running\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "dataset_name": "string",
  "objective_name": "string",
  "status": "running"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/optimizations")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```