Skip to main content
POST
/
lens
/
modify
curl -X POST https://api.u1.archetypeai.app/v0.5/lens/modify \
  -H "Authorization: Bearer $ATAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lens_id": "lns-test-lens-b2ba0058",
    "lens_name": "Updated Lens Name"
  }'
{
  "lens_id": "lns-test-lens-b2ba0058",
  "lens_name": "Updated Lens Name",
  "lens_status": "LENS_STATUS_MOUNTED",
  "lens_modifiable": true,
  "lens_config": {
    "model_pipeline": [
      {
        "processor_name": "lens_noop_processor",
        "processor_config": {}
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.archetypeai.app/llms.txt

Use this file to discover all available pages before exploring further.

Overview

This endpoint modifies an existing lens template, overwriting any previous settings of that template. Only lens templates that are modifiable can be modified. Developers can check if a lens template is modifiable via the /lens/metadata API (look for lens_modifiable: true).

Request Body

lens_id
string
required
The ID of the lens to modify (must be a modifiable lens)
lens_name
string
Updated name for the lens
lens_config
object
Updated configuration for the lens

Response

lens_id
string
ID of the modified lens
lens_name
string
Updated name of the lens
lens_modifiable
boolean
Whether the lens can be further modified
lens_status
string
Current status of the lens
lens_config
object
Updated lens configuration
curl -X POST https://api.u1.archetypeai.app/v0.5/lens/modify \
  -H "Authorization: Bearer $ATAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lens_id": "lns-test-lens-b2ba0058",
    "lens_name": "Updated Lens Name"
  }'
{
  "lens_id": "lns-test-lens-b2ba0058",
  "lens_name": "Updated Lens Name",
  "lens_status": "LENS_STATUS_MOUNTED",
  "lens_modifiable": true,
  "lens_config": {
    "model_pipeline": [
      {
        "processor_name": "lens_noop_processor",
        "processor_config": {}
      }
    ]
  }
}