> ## Documentation Index > Fetch the complete documentation index at: https://docs.lusor.ai/llms.txt > Use this file to discover all available pages before exploring further. # Rename a session > Sets the session's display name. Send `name: null` to clear it, so the name is derived from the prompt again. Returns the updated session. Workspace scope is resolved from `workspaceId` in the JSON body, or the workspace bound to the API key, so API-key callers may omit it. ## OpenAPI ````yaml /api-reference/openapi.yaml patch /v1/sessions/{id} openapi: 3.1.0 info: title: Lusor API version: 0.1.0 description: | Run AI agents on real phones, or drive a phone directly with deterministic actions. ## Authentication Every `/v1/*` endpoint except `GET /v1/health` requires an API key. Create one in the Lusor dashboard under **Settings → API Keys**. A key is shown once and is bound to one workspace. Revoking it there stops it working immediately. Send it in either header: - `X-Api-Key: ` - `Authorization: Bearer ` Because a key is bound to its workspace, `workspaceId` query and body parameters are optional for API-key callers. A request that names a different workspace returns an opaque `404`. ## Runs Use `POST /v1/agents/{id}/turns` to start or continue an agent run. Read the run under `/v1/sessions/{id}`; poll `GET /v1/sessions/{id}/status` or `GET /v1/sessions/{id}/events` for progress. ## Errors Errors are JSON: `{ "error": "", "message": "" }`. A request that fails validation returns `400` in one of two shapes, depending on the endpoint: `{ "error": "validation_error", "details": { ... } }` (direct phone control actions, for example), or `{ "error": "bad_request", "message": "" }` (agent endpoints, for example). Branch on `error`. contact: name: Lusor url: https://lusor.ai license: name: Proprietary url: https://lusor.ai/terms servers: - url: https://api.lusor.ai description: Production security: - ApiKey: [] - BearerAuth: [] tags: - name: Agents description: Persistent agents, the phone each one uses, and their turns (runs). - name: Secrets description: | Secrets saved in a workspace (passwords, sign-in details). A run uses them by name through `secrets`; values never travel in a request. - name: Sessions description: | Run records: list, inspect, stop, and read events and artifacts. Start a run with `POST /v1/agents/{id}/turns`, or without an agent through `POST /v1/workspaces/{workspaceId}/devices/{deviceId}/sessions`. - name: LiveView description: | View-only WebRTC live view of a session's phone: signaling, ICE servers, and stream control. API keys get live view only on the customer's own phone, not on a Lusor Phone. - name: Devices description: | The phones in your workspace, and reads of their current screen and UI tree. - name: DeviceVerbs description: | Direct phone control: deterministic actions (tap, swipe, type, key, clear, back, home, recent, screenshot, apps/start, apps/stop) and chains of them. On a Lusor Phone, API-key calls meter phone minutes. - name: Shell description: | Restricted shell escape hatch. Commands are checked against a denylist and audit-logged. No command output is returned. - name: Datasets description: Lists a run produced, saved as reusable Datasets. - name: Skills description: Reusable automation skills (Markdown documents). - name: PhoneNumbers description: | Workspace phone numbers and their stored SMS messages. Read-only for API keys. - name: Emails description: | Workspace Agent Mail addresses and stored inbound mail. Read-only: there is no compose, reply, or send endpoint, and message bodies are returned as raw plain text without HTML execution, remote asset fetches, or code extraction. - name: Workspaces description: The workspace an API key is bound to. - name: Catalog description: The catalog of apps that can be installed on a Lusor Phone. - name: Health description: Service health check. paths: /v1/sessions/{id}: patch: tags: - Sessions summary: Rename a session description: | Sets the session's display name. Send `name: null` to clear it, so the name is derived from the prompt again. Returns the updated session. Workspace scope is resolved from `workspaceId` in the JSON body, or the workspace bound to the API key, so API-key callers may omit it. operationId: updateSession parameters: - $ref: '#/components/parameters/SessionId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSessionInput' responses: '200': description: Updated session content: application/json: schema: $ref: '#/components/schemas/SessionDetail' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' components: parameters: SessionId: name: id in: path required: true schema: type: string description: Session ID. schemas: UpdateSessionInput: allOf: - $ref: '#/components/schemas/WorkspaceScopeInput' - type: object required: - name properties: name: type: - string - 'null' minLength: 1 maxLength: 120 description: New display name (trimmed); `null` clears it. SessionDetail: description: | One run. Content is kept for the workspace's history window; each `*ExpiresAt` field says when the matching field expires. allOf: - $ref: '#/components/schemas/SessionV2' - type: object properties: agentId: type: - string - 'null' format: uuid description: >- The agent that ran this turn; null for runs started without an agent. name: type: - string - 'null' description: Display name; null means derive it from the prompt. promptExpiresAt: type: - string - 'null' format: date-time outputExpiresAt: type: - string - 'null' format: date-time nameExpiresAt: type: - string - 'null' format: date-time errorExpiresAt: type: - string - 'null' format: date-time WorkspaceScopeInput: type: object properties: workspaceId: type: string format: uuid description: Optional for workspace-scoped API keys. SessionV2: type: object required: - id - prompt - status - createdAt properties: id: type: string prompt: type: string status: $ref: '#/components/schemas/SessionStatusV2' deviceId: type: - string - 'null' workspaceId: type: - string - 'null' format: uuid app: type: - string - 'null' outputSchema: type: - object - 'null' additionalProperties: true output: oneOf: - type: object additionalProperties: true - type: array items: {} - type: 'null' description: | Structured output. Populated when `status == completed`. Shape is caller-defined via `outputSchema` on session create. error: type: - string - 'null' description: | Machine-readable failure code when `status == failed`. Known code: `secret_required:` - a run created with an API key needed a credential or 2FA code (`` is the agent's slug for it, for example `gmail_password`) that it was not given. The run ends immediately rather than waiting for a human. Save the secret in the workspace, then retry the run naming it in `secrets` (`.`). Dashboard runs never fail this way: they pause in `awaiting_human` and are answered in the dashboard. Known code: `credits_exhausted` - the run's model cost reached the workspace's credit balance at the time the run started, so it stopped; upgrade the plan or buy a credit pack, then continue the session. createdAt: type: string format: date-time startedAt: type: - string - 'null' format: date-time completedAt: type: - string - 'null' format: date-time maxDurationSecs: type: - integer - 'null' format: int64 description: >- Effective per-session duration cap in seconds as persisted by the API at session creation. Null means a historical row has no persisted cap; consumers must not infer the current default from null. ValidationErrorResponse: type: object required: - error - details properties: error: type: string example: validation_error details: type: object additionalProperties: true ErrorResponse: type: object required: - error - message properties: error: type: string message: type: string SessionStatusV2: type: string enum: - queued - running - executing - awaiting_human - complete - completed - failed - cancelled responses: ValidationError: description: | Request validation failed. Either `validation_error` with per-field `details`, or `bad_request` with a `message`, depending on the endpoint. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationErrorResponse' - $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Authentication required or invalid credentials. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key description: Workspace API key, created in the dashboard under Settings → API Keys. BearerAuth: type: http scheme: bearer description: >- The same workspace API key, sent as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.