Retrieve blueprint by name | Opik Documentation

curl http://localhost:5173/api/v1/private/agent-configs/blueprints/projects/project_id/names/name \
     -H "Content-Type: application/json"

{
  "type": "blueprint",
  "values": [
    {
      "key": "max_retries",
      "type": "integer",
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "project_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
      "value": "5",
      "description": "Maximum number of retry attempts for failed jobs",
      "valid_from_blueprint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "valid_to_blueprint_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Data Processing Blueprint",
  "description": "Blueprint for standard data ingestion and preprocessing pipeline",
  "envs": [
    "production",
    "staging"
  ],
  "created_by": "alice.jones@example.com",
  "created_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "bob.smith@example.com",
  "last_updated_at": "2024-01-15T09:30:00Z"
}

Retrieves a specific blueprint by its name within a project

Path parameters

namestringRequired

project_idstringRequiredformat: "uuid"

Query parameters

mask_idstringOptionalformat: "uuid"

Response

Blueprint retrieved

typeenum

Allowed values:

valueslist of objects

idstring or nullformat: "uuid"

namestring or nullRead-only

descriptionstring or null0-255 characters

envslist of strings or nullRead-only

created_bystring or nullRead-only

created_atdatetime or nullRead-only

last_updated_bystring or nullRead-only

last_updated_atdatetime or nullRead-only

Path parameters

Query parameters

Response

Errors