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

# Sessions

> The sessions created for imported containers, most records first.

Each gives its container's display name and source, how many records it
holds, and whether reasoning is on for it. Only workspace and admin keys may
call it.
Experimental: ingest may change or stop working without notice.

> [!WARNING]
>
> Ingest is experimental: this endpoint may change or stop working without notice. See [Ingesting Source Records](https://honcho.dev/docs/v3/documentation/features/advanced/ingest.md).


## OpenAPI

````yaml get /v3/workspaces/{workspace_id}/ingest/sessions
openapi: 3.1.0
info:
  title: Honcho API
  summary: The Identity Layer for the Agentic World
  description: >-
    Honcho is a platform for giving agents user-centric memory and social
    cognition.
  contact:
    name: Plastic Labs
    url: https://honcho.dev/
    email: hello@plasticlabs.ai
  license:
    name: GNU Affero General Public License v3.0
    url: https://github.com/plastic-labs/honcho/blob/main/LICENSE
  version: 3.6.2
servers:
  - url: https://api.honcho.dev
    description: Production SaaS Platform
security: []
paths:
  /v3/workspaces/{workspace_id}/ingest/sessions:
    get:
      tags:
        - ingest
      summary: Sessions
      description: >-
        The sessions created for imported containers, most records first.


        Each gives its container's display name and source, how many records it

        holds, and whether reasoning is on for it. Only workspace and admin keys
        may

        call it.

        Experimental: ingest may change or stop working without notice.
      operationId: sessions_v3_workspaces__workspace_id__ingest_sessions_get
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            description: ID of the workspace
            title: Workspace Id
          description: ID of the workspace
        - name: page
          in: query
          required: false
          schema:
            type: integer
            maximum: 2147483647
            minimum: 1
            description: Page number (offset mode)
            default: 1
            title: Page
          description: Page number (offset mode)
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Page size
            default: 50
            title: Size
          description: Page size
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Opt in to cursor pagination. Send an empty value for the first
              page, then the `next_page` value from each response. When set,
              `page` is ignored and the response is a cursor page with no
              `total`.
            title: Cursor
          description: >-
            Opt in to cursor pagination. Send an empty value for the first page,
            then the `next_page` value from each response. When set, `page` is
            ignored and the response is a cursor page with no `total`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/Page_IngestSessionSummary_'
                  - $ref: '#/components/schemas/CursorPage_IngestSessionSummary_'
                title: >-
                  Response Sessions V3 Workspaces  Workspace Id  Ingest Sessions
                  Get
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Not an auto workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    Page_IngestSessionSummary_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/IngestSessionSummary'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
          description: >-
            Number of matching rows, exact up to the server's
            PAGINATION_COUNT_LIMIT (default 100000) and reported as that limit
            plus one when there are more. While a next page exists it is at
            least one more than this page's last row, so `pages` always reaches
            the end of the list.
        page:
          type: integer
          minimum: 1
          title: Page
        size:
          type: integer
          minimum: 1
          title: Size
        pages:
          type: integer
          minimum: 0
          title: Pages
      type: object
      required:
        - items
        - total
        - page
        - size
        - pages
      title: Page[IngestSessionSummary]
    CursorPage_IngestSessionSummary_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/IngestSessionSummary'
          type: array
          title: Items
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
        current_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Current Page
          description: Cursor to refetch the current page
        current_page_backwards:
          anyOf:
            - type: string
            - type: 'null'
          title: Current Page Backwards
          description: Cursor to refetch the current page starting from the last item
        previous_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Previous Page
          description: Cursor for the previous page
        next_page:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Page
          description: Cursor for the next page
      type: object
      required:
        - items
      title: CursorPage[IngestSessionSummary]
    ErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: What went wrong
      type: object
      required:
        - detail
      title: ErrorResponse
      description: >-
        The body returned for every raised HonchoException.


        `HTTPValidationError` is FastAPI's own 422 shape, whose `detail` is an
        array

        of per-field errors. Honcho's handler returns a single message string

        instead (see `honcho_exception_handler` in `src/main.py`), so error
        codes

        raised from application code document this schema rather than that one.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    IngestSessionSummary:
      properties:
        session_id:
          type: string
          title: Session Id
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
          description: The container's display name in the source
        source:
          type: string
          title: Source
        source_instance:
          type: string
          title: Source Instance
        messages:
          type: integer
          title: Messages
          description: Records in the session
        modeled:
          type: boolean
          title: Modeled
          description: >-
            False when reasoning is off for the session (its own setting, else
            the workspace's): only summaries are made
      type: object
      required:
        - session_id
        - source
        - source_instance
        - messages
        - modeled
      title: IngestSessionSummary
      description: A session created for an imported container.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.