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

# Derive

> Derive records that were ingested with `derive: "later"`.

Each call releases up to 1,000 deferred records, a session at a time, and
queues their derivation. Call again until `remaining` is 0. Configuration
and observers are resolved when a record is queued, not when it was
ingested. 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 post /v3/workspaces/{workspace_id}/ingest/derive
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/derive:
    post:
      tags:
        - ingest
      summary: Derive
      description: >-
        Derive records that were ingested with `derive: "later"`.


        Each call releases up to 1,000 deferred records, a session at a time,
        and

        queues their derivation. Call again until `remaining` is 0.
        Configuration

        and observers are resolved when a record is queued, not when it was

        ingested. Only workspace and admin keys may call it.


        Experimental: ingest may change or stop working without notice.
      operationId: derive_v3_workspaces__workspace_id__ingest_derive_post
      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/IngestDeriveResponse'
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '503':
          description: >-
            Contention outlasted the retries; nothing was released. Calling
            again is safe.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    IngestDeriveResponse:
      properties:
        pending:
          type: integer
          title: Pending
          description: >-
            Deferred records this call released for derivation. They are queued
            before the response, or shortly after by a background sweep when
            their session was busy.
        remaining:
          type: integer
          title: Remaining
          description: Records in the workspace still deferred after this call
      type: object
      required:
        - pending
        - remaining
      title: IngestDeriveResponse
      description: What one derive call released. Call again until `remaining` is 0.
    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
    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.