Update Session Metadata

POST/v1/agents/sessions/{session_id}

Replace the Session metadata map. metadata is the only accepted field; anything else returns 400. Archived Sessions return 404.

Path parameters

stringsession_idrequired

Session ID (ses_ prefix).

Request body

JSON object.

objectmetadatarequired

Complete new metadata map, up to 16 string pairs.

curl -X POST https://api.sandbase.ai/v1/agents/sessions/ses_5b0e7c3a-91d2-5f4e-8a6b-2c9d4e1f7a83 \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "ticket": "OPS-142"
    }
  }'

Response200 OK

{
  "id": "ses_5b0e7c3a-91d2-5f4e-8a6b-2c9d4e1f7a83",
  "object": "agent.session",
  "agent": {
    "id": "agt_8c1f2b9e-3d4a-4f6b-9c2e-1a7d5e3b4c60",
    "name": "Research assistant",
    "model": "deepseek/deepseek-v4-flash",
    "instructions": "Answer with cited sources.",
    "multi_agent": {
      "enabled": false,
      "max_concurrent_subagents": null
    },
    "reasoning": {
      "effort": null,
      "summary": null
    },
    "service_tier": "auto",
    "text": {
      "format": {
        "type": "text"
      },
      "verbosity": "medium"
    },
    "tools": []
  },
  "agent_id": "agt_8c1f2b9e-3d4a-4f6b-9c2e-1a7d5e3b4c60",
  "agent_version": 1,
  "title": "Market scan",
  "model": "deepseek/deepseek-v4-flash",
  "environment": {
    "id": "env_…",
    "type": "openai_hosted",
    "capability_directories": [],
    "files": [],
    "network": {
      "access": "enabled",
      "allowed_domains": []
    },
    "packages": {
      "npm": [],
      "python": [],
      "system": []
    },
    "plugins": [],
    "skills": []
  },
  "metadata": {
    "ticket": "OPS-142"
  },
  "status": "idle",
  "lifecycle_status": "active",
  "sync_status": "ready",
  "execution_status": "idle",
  "failure": null,
  "row_version": 1,
  "required_actions": [],
  "vault_ids": [],
  "usage": null,
  "created_at": 1791273600,
  "last_active_at": 1791273600,
  "updated_at": 1791273600,
  "archived_at": null,
  "source": "direct",
  "source_id": null
}