Honcho Users API

The users API from Honcho — 5 operation(s) for users.

GitHub OpenAPI

Operations 6

POST /v1/apps/{app_id}/users Create User #
GET /v1/apps/{app_id}/users Get User #
POST /v1/apps/{app_id}/users/list Get Users #
GET /v1/apps/{app_id}/users/name/{name} Get User By Name #
GET /v1/apps/{app_id}/users/get_or_create/{name} Get Or Create User #
PUT /v1/apps/{app_id}/users/{user_id} Update User #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/honcho-dev:honcho-dev-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

honcho-dev-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Honcho Users 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: Users
paths:
  /v1/apps/{app_id}/users:
    post:
      tags:
      - Users
      summary: Create User
      description: Create a new User
      operationId: create_user_v1_apps__app_id__users_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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreate'
              description: User creation parameters
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '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 user = await client.apps.users.create('app_id', { name: 'x' });\n\n  console.log(user.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)\nuser = client.apps.users.create(\n    app_id=\"app_id\",\n    name=\"x\",\n)\nprint(user.id)"
    get:
      tags:
      - Users
      summary: Get User
      description: 'Get a User by ID


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

        Otherwise, it uses the user_id from the JWT.'
      operationId: get_user_v1_apps__app_id__users_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: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: User ID to retrieve. If not provided, uses JWT
          title: User Id
        description: User ID to retrieve. If not provided, uses JWT
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '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 user = await client.apps.users.get('app_id');\n\n  console.log(user.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)\nuser = client.apps.users.get(\n    app_id=\"app_id\",\n)\nprint(user.id)"
  /v1/apps/{app_id}/users/list:
    post:
      tags:
      - Users
      summary: Get Users
      description: Get All Users for an App
      operationId: get_users_v1_apps__app_id__users_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: reverse
        in: query
        required: false
        schema:
          type: boolean
          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/UserGet'
              - type: 'null'
              description: Filtering options for the users list
              title: Options
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_User_'
        '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 user of client.apps.users.list('app_id')) {\n    console.log(user.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.list(\n    app_id=\"app_id\",\n)\npage = page.items[0]\nprint(page.id)"
  /v1/apps/{app_id}/users/name/{name}:
    get:
      tags:
      - Users
      summary: Get User By Name
      description: Get a User by name
      operationId: get_user_by_name_v1_apps__app_id__users_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: name
        in: path
        required: true
        schema:
          type: string
          description: Name of the user to retrieve
          title: Name
        description: Name of the user to retrieve
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '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 user = await client.apps.users.getByName('app_id', 'name');\n\n  console.log(user.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)\nuser = client.apps.users.get_by_name(\n    name=\"name\",\n    app_id=\"app_id\",\n)\nprint(user.id)"
  /v1/apps/{app_id}/users/get_or_create/{name}:
    get:
      tags:
      - Users
      summary: Get Or Create User
      description: Get a User or create a new one by the input name
      operationId: get_or_create_user_v1_apps__app_id__users_get_or_create__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: name
        in: path
        required: true
        schema:
          type: string
          description: Name of the user to get or create
          title: Name
        description: Name of the user to get or create
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '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 user = await client.apps.users.getOrCreate('app_id', 'name');\n\n  console.log(user.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)\nuser = client.apps.users.get_or_create(\n    name=\"name\",\n    app_id=\"app_id\",\n)\nprint(user.id)"
  /v1/apps/{app_id}/users/{user_id}:
    put:
      tags:
      - Users
      summary: Update User
      description: Update a User's name and/or metadata
      operationId: update_user_v1_apps__app_id__users__user_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 to update
          title: User Id
        description: ID of the user to update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdate'
              description: Updated user parameters
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '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 user = await client.apps.users.update('app_id', 'user_id');\n\n  console.log(user.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)\nuser = client.apps.users.update(\n    user_id=\"user_id\",\n    app_id=\"app_id\",\n)\nprint(user.id)"
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserGet:
      properties:
        filter:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filter
      type: object
      title: UserGet
    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
    UserUpdate:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
      type: object
      title: UserUpdate
    User:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        app_id:
          type: string
          title: App Id
        created_at:
          type: string
          format: date-time
          title: Created At
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          default: {}
      type: object
      required:
      - id
      - name
      - app_id
      - created_at
      title: User
    Page_User_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/User'
          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[User]
    UserCreate:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          default: {}
      type: object
      required:
      - name
      title: UserCreate
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer