Skip to main content
Opik Documentation

Search documentation

Type to search this documentation.

Create optimizer config with initial blueprint

POST/v1/private/agent-configs/blueprintsCreate optimizer config with initial blueprint

Creates a new optimizer config with initial blueprint. Fails if the project already has a config.

Request body

application/json
objectAgentConfigCreate_Write
blueprintobjectrequired
Show child attributes
descriptionstring

maxLength 255 · minLength 0

idstring · uuid
typestringrequired

one of "blueprint", "mask"

valuesarray of objectrequired

maxItems 250 · minItems 1

Show child attributes

maxItems 250 · minItems 1

Show array items
descriptionstring
keystringrequired

maxLength 255 · minLength 0

typestringrequired

one of "string", "integer", "float", "boolean", "prompt", "prompt_commit"

valuestring
idstring · uuid

Agent config ID. Generated automatically if not provided

project_idstring · uuid

Project ID. Either project_id or project_name must be provided

project_namestring

Project name. Either project_id or project_name must be provided

pattern (?s)^\s*(\S.*\S|\S)\s*$

Example request
{
  "blueprint": {
    "description": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "blueprint",
    "values": [
      {
        "description": "string",
        "key": "string",
        "type": "boolean",
        "value": "string"
      }
    ]
  },
  "id": "00000000-0000-0000-0000-000000000000",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string"
}

Responses

201Created

Headers

Location
400Bad Request (e.g. MASK type not allowed)application/json
objectErrorMessage_Write
errorsarray of string
Show child attributes
Example response
{
  "errors": [
    "string"
  ]
}
401Unauthorizedapplication/json
objectErrorMessage_Write
errorsarray of string
Show child attributes
Example response
{
  "errors": [
    "string"
  ]
}
409Conflict (config already exists)application/json
objectErrorMessage_Write
errorsarray of string
Show child attributes
Example response
{
  "errors": [
    "string"
  ]
}
Documentation menu