Arcee AI User API

The User API from Arcee AI — 12 operation(s) for user.

GitHub OpenAPI

Operations 14

PUT /app/v1/users/{user_id} Update User Password #
GET /app/v1/users Get All Users #
GET /app/v1/users/app_roles Get Users App Roles Entries #
GET /app/v1/users/{user_id}/admin-details Get Admin User Details #
PUT /app/v1/users/app_role Update User App Role #
POST /app/v1/users/role Update User Role #
PUT /app/v1/users/profile Update User Profile #
GET /app/v1/me Get Current User Info #
PUT /app/v1/users/theme Update Theme #
PUT /app/v1/users/language Update Language #
PUT /app/v1/users/balance-visibility Update Balance Visibility #
PUT /app/v1/users/github-email-mismatch-banner-home Update Github Email Mismatch Banner Home #
PUT /app/v1/users/ui-retention-acknowledgement Acknowledge Ui Retention #
DELETE /app/v1/delete-my-account Delete My Account #

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/arcee-ai:arcee-ai-user-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

arcee-ai-user-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AFM User API
  version: 0.1.0
tags:
- name: User
paths:
  /app/v1/users/{user_id}:
    put:
      tags:
      - User
      summary: Update User Password
      description: Update your own profile. Password changes use /change-password.
      operationId: update_user_password_app_v1_users__user_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          title: User Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /app/v1/users:
    get:
      tags:
      - User
      summary: Get All Users
      description: Get all users in the system, requires admin privileges
      operationId: get_all_users_app_v1_users_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /app/v1/users/app_roles:
    get:
      tags:
      - User
      summary: Get Users App Roles Entries
      description: 'Get paginated list of users with their app roles, requires admin privileges

        include_deleted: If True, includes deleted/anonymized accounts (default: False)

        signup_campaign: Repeatable; keeps only users who signed up via one of those campaign slugs'
      operationId: get_users_app_roles_entries_app_v1_users_app_roles_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Page
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Page Size
      - name: search
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Search
      - name: include_deleted
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Deleted
      - name: signup_campaign
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          title: Signup Campaign
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAppRoleResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /app/v1/users/{user_id}/admin-details:
    get:
      tags:
      - User
      summary: Get Admin User Details
      operationId: get_admin_user_details_app_v1_users__user_id__admin_details_get
      security:
      - HTTPBearer: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
          title: User Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminUserDetailsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /app/v1/users/app_role:
    put:
      tags:
      - User
      summary: Update User App Role
      description: Update a user's app role, requires internal privileges.
      operationId: update_user_app_role_app_v1_users_app_role_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAppRoleUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/users/role:
    post:
      tags:
      - User
      summary: Update User Role
      description: Update a user's role, requires admin privileges."
      operationId: update_user_role_app_v1_users_role_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRoleUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/users/profile:
    put:
      tags:
      - User
      summary: Update User Profile
      operationId: update_user_profile_app_v1_users_profile_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/me:
    get:
      tags:
      - User
      summary: Get Current User Info
      description: Get current authenticated user information
      operationId: get_current_user_info_app_v1_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /app/v1/users/theme:
    put:
      tags:
      - User
      summary: Update Theme
      description: Update user's theme mode preference
      operationId: update_theme_app_v1_users_theme_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ThemeUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/users/language:
    put:
      tags:
      - User
      summary: Update Language
      description: Update user's language preference
      operationId: update_language_app_v1_users_language_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LanguageUpdateRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/users/balance-visibility:
    put:
      tags:
      - User
      summary: Update Balance Visibility
      description: Update user's balance visibility preference
      operationId: update_balance_visibility_app_v1_users_balance_visibility_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalanceVisibilityRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/users/github-email-mismatch-banner-home:
    put:
      tags:
      - User
      summary: Update Github Email Mismatch Banner Home
      description: Update user's GitHub email mismatch home-banner preference.
      operationId: update_github_email_mismatch_banner_home_app_v1_users_github_email_mismatch_banner_home_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GitHubEmailMismatchBannerHomeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/users/ui-retention-acknowledgement:
    put:
      tags:
      - User
      summary: Acknowledge Ui Retention
      description: Acknowledge, for the active organization, that UI activity is retained.
      operationId: acknowledge_ui_retention_app_v1_users_ui_retention_acknowledgement_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UIRetentionAcknowledgementRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UIRetentionAcknowledgementResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /app/v1/delete-my-account:
    delete:
      tags:
      - User
      summary: Delete My Account
      description: 'Delete current user''s account (self-deletion).

        Synchronously processes deletion.'
      operationId: delete_my_account_app_v1_delete_my_account_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
components:
  schemas:
    UserUpdateRequest:
      properties:
        first_name:
          anyOf:
          - type: string
          - type: 'null'
          title: First Name
        last_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Name
        preferences:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Preferences
        password:
          anyOf:
          - type: string
          - type: 'null'
          title: Password
      type: object
      required:
      - first_name
      - last_name
      - preferences
      - password
      title: UserUpdateRequest
    UserRoleUpdateRequest:
      properties:
        user_id:
          type: string
          title: User Id
        new_role:
          type: string
          title: New Role
      type: object
      required:
      - user_id
      - new_role
      title: UserRoleUpdateRequest
    AppRoleEntry:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        email:
          type: string
          title: Email
        first_name:
          type: string
          title: First Name
        last_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Name
        app_role:
          type: string
          title: App Role
      type: object
      required:
      - id
      - email
      - first_name
      - last_name
      - app_role
      title: AppRoleEntry
    GitHubEmailMismatchBannerHomeRequest:
      properties:
        show_mismatch_banner_home:
          type: boolean
          title: Show Mismatch Banner Home
      type: object
      required:
      - show_mismatch_banner_home
      title: GitHubEmailMismatchBannerHomeRequest
    AdminUserDetailsResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        email:
          type: string
          title: Email
        first_name:
          type: string
          title: First Name
        last_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Name
        created_at:
          type: string
          format: date-time
          title: Created At
        app_role:
          type: string
          title: App Role
        organizations:
          items:
            $ref: '#/components/schemas/AdminUserOrganization'
          type: array
          title: Organizations
      type: object
      required:
      - id
      - email
      - first_name
      - last_name
      - created_at
      - app_role
      - organizations
      title: AdminUserDetailsResponse
    UIRetentionAcknowledgementResponse:
      properties:
        success:
          type: boolean
          title: Success
        ui_retention_notice_version:
          type: integer
          title: Ui Retention Notice Version
        active_profile_id:
          type: string
          format: uuid
          title: Active Profile Id
      type: object
      required:
      - success
      - ui_retention_notice_version
      - active_profile_id
      title: UIRetentionAcknowledgementResponse
    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
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    UIRetentionAcknowledgementRequest:
      properties:
        active_profile_id:
          type: string
          format: uuid
          title: Active Profile Id
      type: object
      required:
      - active_profile_id
      title: UIRetentionAcknowledgementRequest
    LanguageUpdateRequest:
      properties:
        language:
          type: string
          title: Language
      type: object
      required:
      - language
      title: LanguageUpdateRequest
    UserRole:
      type: string
      enum:
      - admin
      - user
      - viewer
      - owner
      title: UserRole
    BalanceVisibilityRequest:
      properties:
        show_balance_in_sidebar:
          type: boolean
          title: Show Balance In Sidebar
      type: object
      required:
      - show_balance_in_sidebar
      title: BalanceVisibilityRequest
    PaginatedAppRoleResponse:
      properties:
        entries:
          items:
            $ref: '#/components/schemas/AppRoleEntry'
          type: array
          title: Entries
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total_pages:
          type: integer
          title: Total Pages
        has_next:
          type: boolean
          title: Has Next
        has_prev:
          type: boolean
          title: Has Prev
      type: object
      required:
      - entries
      - total
      - page
      - page_size
      - total_pages
      - has_next
      - has_prev
      title: PaginatedAppRoleResponse
    UserAppRoleUpdateRequest:
      properties:
        user_id:
          type: string
          title: User Id
        new_role:
          $ref: '#/components/schemas/AppRole'
      type: object
      required:
      - user_id
      - new_role
      title: UserAppRoleUpdateRequest
    AppRole:
      type: string
      enum:
      - int_user
      - int_editor
      - int_admin
      - ext_user
      - ext_tester
      - ext_partner
      title: AppRole
      description: Roles for role-based access control.
    AdminUserOrganization:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        role:
          $ref: '#/components/schemas/UserRole'
        is_primary:
          type: boolean
          title: Is Primary
      type: object
      required:
      - id
      - name
      - role
      - is_primary
      title: AdminUserOrganization
    ThemeUpdateRequest:
      properties:
        theme:
          type: string
          title: Theme
      type: object
      required:
      - theme
      title: ThemeUpdateRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Arcee AI
  source: https://api.arcee.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)