> ## Documentation Index
> Fetch the complete documentation index at: https://docs.raydocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Session

> Update session name or settings.

## Authentication & Scope

Requires the `sessions-write` ability.

## Request

```http theme={null}
PUT /extractions/sessions/770e8400-e29b-41d4-a716-446655440000 HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Q1 2024 Invoices (Updated)"
}
```

### Path Parameters

| Parameter   | Type | Required | Description    |
| ----------- | ---- | -------- | -------------- |
| `sessionId` | uuid | Yes      | The session ID |

### Body Parameters

| Parameter | Type   | Required | Description          |
| --------- | ------ | -------- | -------------------- |
| `name`    | string | No       | Updated session name |

## Response

`200 OK` – The updated session.

```json theme={null}
{
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "name": "Q1 2024 Invoices (Updated)",
  "extraction_template_id": "550e8400-e29b-41d4-a716-446655440000",
  "settings": {},
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-16T09:00:00Z"
}
```


## OpenAPI

````yaml put /extractions/sessions/{sessionId}
openapi: 3.0.1
info:
  title: Raydocs API
  description: REST API for document extraction with AI-powered data parsing
  version: 1.0.0
servers:
  - url: https://api.raydocs.com
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: Create and manage workspaces.
  - name: Workspace Users
    description: Manage users within a workspace.
  - name: Extraction Templates
    description: Define extraction schemas and settings.
  - name: Extraction Sessions
    description: Manage extraction jobs and documents.
  - name: Batch Operations
    description: Bulk operations on sessions.
  - name: Documents
    description: Upload and manage source documents.
  - name: Workflows
    description: Discover workflow runs and read their public outputs.
  - name: Results
    description: Access extraction results.
paths:
  /extractions/sessions/{sessionId}:
    put:
      tags:
        - Extraction Sessions
      summary: Update Session
      description: Update session name or settings. Requires `sessions-write`.
      operationId: updateSession
      parameters:
        - name: sessionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractionSession'
        '403':
          description: Forbidden
components:
  schemas:
    ExtractionSession:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        name:
          type: string
        extraction_template_id:
          type: string
          format: uuid
        settings:
          type: object
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        documents:
          type: array
          items:
            $ref: '#/components/schemas/Document'
          readOnly: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/ExtractionResult'
          readOnly: true
    Document:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        workspace_id:
          type: integer
        filename:
          type: string
        mime:
          type: string
        size:
          type: integer
          description: File size in bytes
        sha256:
          type: string
          minLength: 64
          maxLength: 64
        status:
          type: string
          enum:
            - uploaded
            - queued
            - parsing
            - parsed
            - processed
            - failed
        source_type:
          type: string
          enum:
            - upload
            - url
            - connector
        source_url:
          type: string
          nullable: true
        parsings:
          type: array
          items:
            $ref: '#/components/schemas/DocumentParsingSummary'
        created_at:
          type: string
          format: date-time
          readOnly: true
    ExtractionResult:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        extraction_session_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - created
            - parsing_pending
            - processing
            - completed
            - failed
        config_hash:
          type: string
          nullable: true
        document_refs:
          type: array
          items:
            $ref: '#/components/schemas/DocumentRef'
        data:
          type: object
          description: Extracted data matching the template schema
        audit_data:
          type: object
          description: Verification/reasoning traces and run audit payload
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    DocumentParsingSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        config_hash:
          type: string
        status:
          type: string
          enum:
            - queued
            - processing
            - ready
            - failed
        parser_version:
          type: string
        updated_at:
          type: string
          format: date-time
    DocumentRef:
      type: object
      required:
        - kind
        - documentId
        - workspaceId
      properties:
        kind:
          type: string
          example: documentRef
        documentId:
          type: string
          format: uuid
        workspaceId:
          type: integer
        filename:
          type: string
        mime:
          type: string
        size:
          type: integer
        sha256:
          type: string
        source:
          type: object
          properties:
            type:
              type: string
              enum:
                - upload
                - url
                - connector
            url:
              type: string
              nullable: true
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        Personal Access Token created from the Raydocs dashboard.

        Include in the Authorization header: `Bearer <your_token>`

        See [API Keys](/api-reference/api-keys) for token creation and
        management.

````