> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.loreos.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.loreos.app/_mcp/server.

# Control Session Lifecycle

PATCH https://api.loreos.app/v1/sessions/{session_id}/lifecycle
Content-Type: application/json

Pause or resume one app-owned user-character session.

``pause`` blocks new user messages and proactive/offscreen runtime paths that require an
active session. It does not delete memory or canon. ``resume`` reactivates the same session.

Reference: https://docs.loreos.app/api-reference/sessions/control-session-lifecycle

## Authentication

- `Authorization` header (bearer token, required) — LoreOS runtime API key (`ck_...`), sent as `Authorization: Bearer <key>`.

## Servers

- `https://api.loreos.app` (Production, default)
- `http://127.0.0.1:8000` (Local development)

## Request

### Path parameters

- `session_id` (string, required)

### Body (application/json)

This endpoint expects a V1SessionLifecycleControlRequest.

- `action` (enum, required) — Pause blocks new user messages; resume returns the session to active.
  - Allowed values: `pause`, `resume`
- `reason` (string, optional, nullable)

## Response

### 200

Successful Response

- `map from string to any`

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (ValidationErrorCtx, optional)

### ValidationErrorLocItems

### ValidationErrorCtx

## Examples

**Request**

```json
{
  "action": "pause",
  "reason": "User requested a break."
}
```

**Response**

```json
{
  "schema_version": "v0",
  "data": {
    "session_id": "00000000-0000-0000-0000-000000000000",
    "lifecycle_state": "paused",
    "status": "paused",
    "event_cursor": 8,
    "semantics": {
      "deletes_memory": false,
      "overwrites_canon": false,
      "blocks_new_user_messages": true,
      "blocks_proactive_runtime": true
    }
  },
  "next_actions": [
    {
      "command": "GET /v1/sessions/00000000-0000-0000-0000-000000000000/state",
      "description": "Confirm the redacted lifecycle state."
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle"

payload = {
    "action": "pause",
    "reason": "User requested a break."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"action":"pause","reason":"User requested a break."}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle"

	payload := strings.NewReader("{\n  \"action\": \"pause\",\n  \"reason\": \"User requested a break.\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"pause\",\n  \"reason\": \"User requested a break.\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"pause\",\n  \"reason\": \"User requested a break.\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle', [
  'body' => '{
  "action": "pause",
  "reason": "User requested a break."
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"action\": \"pause\",\n  \"reason\": \"User requested a break.\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "action": "pause",
  "reason": "User requested a break."
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.loreos.app/v1/sessions/00000000-0000-0000-0000-000000000000/lifecycle")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```