> ## 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.

# Status

> What the workspace's imports produced, for review before deriving.

Records by derivation state, the tokens still deferred, and how many people
and sessions the records map to, with how many of each are not modeled.
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/status
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/status:
    get:
      tags:
        - ingest
      summary: Status
      description: >-
        What the workspace's imports produced, for review before deriving.


        Records by derivation state, the tokens still deferred, and how many
        people

        and sessions the records map to, with how many of each are not modeled.

        Only workspace and admin keys may call it.


        Experimental: ingest may change or stop working without notice.
      operationId: status_v3_workspaces__workspace_id__ingest_status_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
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestStatus'
        '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:
    IngestStatus:
      properties:
        records:
          $ref: '#/components/schemas/IngestRecordCounts'
        deferred_tokens:
          type: integer
          title: Deferred Tokens
          description: Tokens in the messages of deferred records
        people:
          type: integer
          title: People
          description: Peers created for imported accounts
        people_not_modeled:
          type: integer
          title: People Not Modeled
          description: 'Of those, peers with `observe_me` off: nothing is derived about them'
        sessions:
          type: integer
          title: Sessions
          description: Sessions created for imported containers
        sessions_not_modeled:
          type: integer
          title: Sessions Not Modeled
          description: >-
            Of those, sessions whose reasoning is off (their own setting, else
            the workspace's)
        sessions_being_deleted:
          type: integer
          title: Sessions Being Deleted
          description: >-
            Sessions a reset marked for deletion that still hold imported
            records; 0 once the deletion has finished
          default: 0
      type: object
      required:
        - records
        - deferred_tokens
        - people
        - people_not_modeled
        - sessions
        - sessions_not_modeled
      title: IngestStatus
      description: What the workspace's imports produced, for review before deriving.
    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
    IngestRecordCounts:
      properties:
        deferred:
          type: integer
          title: Deferred
          description: Stored, waiting for POST /ingest/derive to release them
        pending:
          type: integer
          title: Pending
          description: Released, about to be queued
        queued:
          type: integer
          title: Queued
          description: Queued for derivation, or derived
      type: object
      required:
        - deferred
        - pending
        - queued
      title: IngestRecordCounts
      description: The workspace's ingested records by derivation state.
    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.