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

Retrieve blueprint by ID

GET
/v1/private/agent-configs/blueprints/:blueprint_id
GET
/api/v1/private/agent-configs/blueprints/:blueprint_id
$curl http://localhost:5173/api/v1/private/agent-configs/blueprints/blueprint_id
1{
2  "type": "blueprint",
3  "values": [
4    {
5      "key": "string",
6      "type": "string",
7      "value": "string",
8      "description": "string"
9    }
10  ],
11  "id": "string",
12  "name": "string",
13  "description": "string",
14  "envs": [
15    "string"
16  ],
17  "created_by": "string",
18  "created_at": "2024-01-15T09:30:00Z",
19  "last_updated_by": "string",
20  "last_updated_at": "2024-01-15T09:30:00Z"
21}
Retrieves a specific blueprint by its ID
Was this page helpful?
Previous

Retrieve blueprint by name

Next
Built with

Path parameters

blueprint_idstringRequiredformat: "uuid"

Query parameters

mask_idstringOptionalformat: "uuid"

Response

Blueprint retrieved
typeenum
Allowed values:
valueslist of objects
idstringformat: "uuid"
namestringRead-only
descriptionstring0-255 characters
envslist of stringsRead-only
created_bystringRead-only
created_atdatetimeRead-only
last_updated_bystringRead-only
last_updated_atdatetimeRead-only

Errors

401
Unauthorized Error
404
Not Found Error