Honcho Collections API

openapi: 3.2.0
info:
  title: Honcho Collections 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
  version: 1.1.0
servers:
- url: http://localhost:8000
  description: Local Development Server
- url: https://demo.honcho.dev
  description: Demo Server
- url: https://api.honcho.dev
  description: Production SaaS Platform
tags:
- name: Collections
paths:
  /v1/apps/{app_id}/users/{user_id}/collections:
    get:
      tags:
      - Collections
      summary: Get Collection
      description: 'Get a specific collection for a user.


        If collection_id is provided as a query parameter, it uses that (must match JWT collection_id).

        Otherwise, it uses the collection_id from the JWT.'
      operationId: get_collection_v1_apps__app_id__users__user_id__collections_get
      security:
      - HTTPBearer: []
      - {}
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the app
          title: App Id
        description: ID of the app
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the user
          title: User Id
        description: ID of the user
      - name: collection_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Collection ID to retrieve. If not provided, uses JWT
          title: Collection Id
        description: Collection ID to retrieve. If not provided, uses JWT
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: JavaScript
        source: "import Honcho from 'honcho-ai';\n\nconst client = new Honcho({\n  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const collection = await client.apps.users.collections.get('app_id', 'user_id');\n\n  console.log(collection.id);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom honcho import Honcho\n\nclient = Honcho(\n    api_key=os.environ.get(\"HONCHO_API_KEY\"),  # This is the default and can be omitted\n)\ncollection = client.apps.users.collections.get(\n    user_id=\"user_id\",\n    app_id=\"app_id\",\n)\nprint(collection.id)"
    post:
      tags:
      - Collections
      summary: Create Collection
      description: Create a new Collection
      operationId: create_collection_v1_apps__app_id__users__user_id__collections_post
      security:
      - HTTPBearer: []
      - {}
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the app
          title: App Id
        description: ID of the app
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the user
          title: User Id
        description: ID of the user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionCreate'
              description: Collection creation parameters
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: JavaScript
        source: "import Honcho from 'honcho-ai';\n\nconst client = new Honcho({\n  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const collection = await client.apps.users.collections.create('app_id', 'user_id', { name: 'x' });\n\n  console.log(collection.id);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom honcho import Honcho\n\nclient = Honcho(\n    api_key=os.environ.get(\"HONCHO_API_KEY\"),  # This is the default and can be omitted\n)\ncollection = client.apps.users.collections.create(\n    user_id=\"user_id\",\n    app_id=\"app_id\",\n    name=\"x\",\n)\nprint(collection.id)"
  /v1/apps/{app_id}/users/{user_id}/collections/list:
    post:
      tags:
      - Collections
      summary: Get Collections
      description: Get All Collections for a User
      operationId: get_collections_v1_apps__app_id__users__user_id__collections_list_post
      security:
      - HTTPBearer: []
      - {}
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the app
          title: App Id
        description: ID of the app
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the user
          title: User Id
        description: ID of the user
      - name: reverse
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether to reverse the order of results
          default: false
          title: Reverse
        description: Whether to reverse the order of results
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number
          default: 1
          title: Page
        description: Page number
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: Page size
          default: 50
          title: Size
        description: Page size
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/CollectionGet'
              - type: 'null'
              description: Filtering options for the collections list
              title: Options
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_Collection_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: JavaScript
        source: "import Honcho from 'honcho-ai';\n\nconst client = new Honcho({\n  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted\n});\n\nasync function main() {\n  // Automatically fetches more pages as needed.\n  for await (const collection of client.apps.users.collections.list('app_id', 'user_id')) {\n    console.log(collection.id);\n  }\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom honcho import Honcho\n\nclient = Honcho(\n    api_key=os.environ.get(\"HONCHO_API_KEY\"),  # This is the default and can be omitted\n)\npage = client.apps.users.collections.list(\n    user_id=\"user_id\",\n    app_id=\"app_id\",\n)\npage = page.items[0]\nprint(page.id)"
  /v1/apps/{app_id}/users/{user_id}/collections/name/{name}:
    get:
      tags:
      - Collections
      summary: Get Collection By Name
      description: Get a Collection by Name
      operationId: get_collection_by_name_v1_apps__app_id__users__user_id__collections_name__name__get
      security:
      - HTTPBearer: []
      - {}
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the app
          title: App Id
        description: ID of the app
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the user
          title: User Id
        description: ID of the user
      - name: name
        in: path
        required: true
        schema:
          type: string
          description: Name of the collection to retrieve
          title: Name
        description: Name of the collection to retrieve
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: JavaScript
        source: "import Honcho from 'honcho-ai';\n\nconst client = new Honcho({\n  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const collection = await client.apps.users.collections.getByName('app_id', 'user_id', 'name');\n\n  console.log(collection.id);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom honcho import Honcho\n\nclient = Honcho(\n    api_key=os.environ.get(\"HONCHO_API_KEY\"),  # This is the default and can be omitted\n)\ncollection = client.apps.users.collections.get_by_name(\n    name=\"name\",\n    app_id=\"app_id\",\n    user_id=\"user_id\",\n)\nprint(collection.id)"
  /v1/apps/{app_id}/users/{user_id}/collections/{collection_id}:
    put:
      tags:
      - Collections
      summary: Update Collection
      description: Update a Collection's name or metadata
      operationId: update_collection_v1_apps__app_id__users__user_id__collections__collection_id__put
      security:
      - HTTPBearer: []
      - {}
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the app
          title: App Id
        description: ID of the app
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the user
          title: User Id
        description: ID of the user
      - name: collection_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the collection to update
          title: Collection Id
        description: ID of the collection to update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionUpdate'
              description: Updated collection parameters
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: JavaScript
        source: "import Honcho from 'honcho-ai';\n\nconst client = new Honcho({\n  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const collection = await client.apps.users.collections.update('app_id', 'user_id', 'collection_id');\n\n  console.log(collection.id);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom honcho import Honcho\n\nclient = Honcho(\n    api_key=os.environ.get(\"HONCHO_API_KEY\"),  # This is the default and can be omitted\n)\ncollection = client.apps.users.collections.update(\n    collection_id=\"collection_id\",\n    app_id=\"app_id\",\n    user_id=\"user_id\",\n)\nprint(collection.id)"
    delete:
      tags:
      - Collections
      summary: Delete Collection
      description: Delete a Collection and its documents
      operationId: delete_collection_v1_apps__app_id__users__user_id__collections__collection_id__delete
      security:
      - HTTPBearer: []
      - {}
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the app
          title: App Id
        description: ID of the app
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the user
          title: User Id
        description: ID of the user
      - name: collection_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the collection to delete
          title: Collection Id
        description: ID of the collection to delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
      - lang: JavaScript
        source: "import Honcho from 'honcho-ai';\n\nconst client = new Honcho({\n  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const collection = await client.apps.users.collections.delete('app_id', 'user_id', 'collection_id');\n\n  console.log(collection);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom honcho import Honcho\n\nclient = Honcho(\n    api_key=os.environ.get(\"HONCHO_API_KEY\"),  # This is the default and can be omitted\n)\ncollection = client.apps.users.collections.delete(\n    collection_id=\"collection_id\",\n    app_id=\"app_id\",\n    user_id=\"user_id\",\n)\nprint(collection)"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CollectionUpdate:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
      type: object
      title: CollectionUpdate
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Page_Collection_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Collection'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        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
      title: Page[Collection]
    CollectionCreate:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          default: {}
      type: object
      required:
      - name
      title: CollectionCreate
    Collection:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        user_id:
          type: string
          title: User Id
        app_id:
          type: string
          title: App Id
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          default: {}
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - name
      - user_id
      - app_id
      - created_at
      title: Collection
    CollectionGet:
      properties:
        filter:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filter
      type: object
      title: CollectionGet
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer