For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • POSTCreate optimizer config with initial blueprint
        • PATCHAdd blueprint to existing config
        • POSTCreate blueprint from mask
        • POSTCreate or update environments
        • GETRetrieve blueprint by environment
        • PUTSet environment by blueprint name
        • DELDelete environment
        • GETRetrieve blueprint by ID
        • GETRetrieve blueprint by name
        • GETGet blueprint history
        • GETRetrieve delta by blueprint ID
        • GETRetrieve latest blueprint
        • POSTRemove configuration parameters
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceAgent Configs

Create optimizer config with initial blueprint

POST
/v1/private/agent-configs/blueprints
POST
/api/v1/private/agent-configs/blueprints
$curl -X POST http://localhost:5173/api/v1/private/agent-configs/blueprints \
>     -H "Content-Type: application/json" \
>     -d '{
>  "blueprint": {
>    "type": "blueprint",
>    "values": [
>      {
>        "key": "string",
>        "type": "string"
>      }
>    ]
>  }
>}'
1{}
Creates a new optimizer config with initial blueprint. Fails if the project already has a config.
Was this page helpful?
Previous

Add blueprint to existing config

Next
Built with

Request

This endpoint expects an object.
blueprintobjectRequired
project_idstringOptionalformat: "uuid"

Project ID. Either project_id or project_name must be provided

project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

Project name. Either project_id or project_name must be provided

idstringOptionalformat: "uuid"
Agent config ID. Generated automatically if not provided

Response headers

Locationstring

Response

Created

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error