Iridium Users API

openapi: 3.2.0
info:
  title: Iridiumhqmcp Com Users API
  version: 0.1.0
  description: 'Operations tagged users across 2 of this provider''s published API definitions: openapi.json, iridiumhqmcp-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Users
paths:
  /accept-terms:
    post:
      tags:
      - Users
      summary: Accept Terms
      description: 'Record ToS/PP assent for an authenticated user. Exempt from the assent gate so a

        not-yet-accepted user can reach it (see _TOS_EXEMPT in main.py).'
      operationId: accept_terms_accept_terms_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptTermsRequest'
        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: []
  /users/me:
    get:
      tags:
      - Users
      summary: Get Me
      operationId: get_me_users_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
    delete:
      tags:
      - Users
      summary: Delete Me
      operationId: delete_me_users_me_delete
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /users/me/rotate-api-key:
    post:
      tags:
      - Users
      summary: Rotate Api Key
      operationId: rotate_api_key_users_me_rotate_api_key_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /users/setup:
    post:
      tags:
      - Users
      summary: Setup User
      operationId: setup_user_users_setup_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsUpdate'
        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: []
  /users/fewshots:
    patch:
      tags:
      - Users
      summary: Update Fewshots
      operationId: update_fewshots_users_fewshots_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FewshotsRequest'
        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: []
  /users/connect-linkedin:
    post:
      tags:
      - Users
      summary: Connect Linkedin
      operationId: connect_linkedin_users_connect_linkedin_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectLinkedInRequest'
        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: []
  /users/connect-linkedin-checkpoint:
    post:
      tags:
      - Users
      summary: Connect Linkedin Checkpoint
      operationId: connect_linkedin_checkpoint_users_connect_linkedin_checkpoint_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckpointRequest'
        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: []
  /users/connect-linkedin-url:
    get:
      tags:
      - Users
      summary: Get Connect Linkedin Url
      operationId: get_connect_linkedin_url_users_connect_linkedin_url_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /users/disconnect-linkedin:
    post:
      tags:
      - Users
      summary: Disconnect Linkedin
      operationId: disconnect_linkedin_users_disconnect_linkedin_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /upload/presign:
    post:
      tags:
      - Users
      summary: Presign Video Upload
      operationId: presign_video_upload_upload_presign_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /linkedin/connections:
    get:
      tags:
      - Users
      summary: Search Connections
      operationId: search_connections_linkedin_connections_get
      security:
      - HTTPBearer: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Q
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CheckpointRequest:
      properties:
        account_id:
          type: string
          title: Account Id
        code:
          type: string
          title: Code
      type: object
      required:
      - account_id
      - code
      title: CheckpointRequest
    AcceptTermsRequest:
      properties:
        agree:
          type: boolean
          title: Agree
        version:
          type: string
          title: Version
      type: object
      required:
      - agree
      - version
      title: AcceptTermsRequest
    FewshotsRequest:
      properties:
        stage4_examples:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Stage4 Examples
      type: object
      required:
      - stage4_examples
      title: FewshotsRequest
    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
    SettingsUpdate:
      properties:
        current_role:
          anyOf:
          - type: string
          - type: 'null'
          title: Current Role
          description: The user's role and company, e.g. 'Founder at Acme'.
        credential_lead:
          anyOf:
          - type: string
          - type: 'null'
          title: Credential Lead
          description: One or two sentences on why the user is credible. Opens outreach messages.
        networking_goal:
          anyOf:
          - type: string
          - type: 'null'
          title: Networking Goal
          description: What the user wants from the people they reach, e.g. 'find design partners'.
        outreach_intent:
          anyOf:
          - type: string
          - type: 'null'
          title: Outreach Intent
          description: 'Message strategy: ''sell'', ''connection'' or ''referral''.'
        style_examples:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Style Examples
          description: Up to 3 approved note texts to imitate.
        target_personas:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Target Personas
          description: Job titles to search for, e.g. ['VP of Engineering', 'Founder'].
        search_keywords:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Search Keywords
          description: Keywords searched alongside the personas, e.g. ['AI platform'].
        target_cities:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Target Cities
          description: Cities to search in, e.g. ['San Francisco', 'New York'].
        target_countries:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Target Countries
          description: Countries to search in, e.g. ['United States'].
        daily_outreach_cap:
          anyOf:
          - type: integer
          - type: 'null'
          title: Daily Outreach Cap
          description: Connection requests per day, clamped to 25.
        comment_topics:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Comment Topics
          description: Subjects searched when finding posts to comment on.
        daily_comment_cap:
          anyOf:
          - type: integer
          - type: 'null'
          title: Daily Comment Cap
          description: Comments per day, clamped to 25.
        network_post_pct:
          anyOf:
          - type: integer
          - type: 'null'
          title: Network Post Pct
          description: Percent of comments sourced from in-network posts; the rest come from keyword search.
        new_position_pct:
          anyOf:
          - type: integer
          - type: 'null'
          title: New Position Pct
          description: Percent of the daily cap allowed for new-role announcement posts.
        comment_author_countries:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Comment Author Countries
          description: Only comment on posts by authors in these countries. Empty means no filter.
        filter_cert_posts:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Filter Cert Posts
          description: Skip 'I just earned/completed/certified' posts.
        filter_hiring_posts:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Filter Hiring Posts
          description: Skip 'we're hiring / open role' posts.
        filter_job_seeking_posts:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Filter Job Seeking Posts
          description: Skip 'open to work / looking for my next role' posts.
        comment_hiring_only:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Comment Hiring Only
          description: 'Only comment on posts tagged #hiring — opt-in, the inverse of filter_hiring_posts.'
        content_topics:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Content Topics
          description: Subjects the user's own posts are drafted about.
        voice_dna:
          anyOf:
          - type: string
          - type: 'null'
          title: Voice Dna
          description: Writing rules applied to every draft, e.g. 'no buzzwords, direct, max 2 sentences'.
        onboarding_goals:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Onboarding Goals
          description: Which pipelines are active. Any of ['commenting', 'content', 'outreach'].
        data_retention_days:
          anyOf:
          - type: integer
          - type: 'null'
          title: Data Retention Days
          description: Days before scraped profiles and drafts are purged.
      type: object
      title: SettingsUpdate
      description: 'Every user-writable setting, in one model — the single description of these columns.


        Both transports bind to this: POST /users/setup (web) and POST /mcp/tools/update_settings

        (MCP + the in-app agent). Field names are the column names on purpose, so the field an

        error names — outreach_blocker in routers/shared/pipelines.py prints raw column names —

        is the argument an agent sends back to fix it, with nothing to translate in between.


        The descriptions are not decoration: fastapi-mcp builds the remote MCP input schema from

        this model (main.py FastApiMCP), and services/agent_tools reads model_json_schema() for

        the in-app agent, so this text is what both agents see. Plain `#` comments are invisible

        to both.


        Every field is optional; only the ones passed are written (model_dump(exclude_none=True)).'
    ConnectLinkedInRequest:
      properties:
        username:
          anyOf:
          - type: string
          - type: 'null'
          title: Username
        password:
          anyOf:
          - type: string
          - type: 'null'
          title: Password
        li_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Li At
        unipile_account_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Unipile Account Id
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
      type: object
      title: ConnectLinkedInRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- iridiumhqmcp-com-openapi.json
x-provenance:
  method: harvested
  publisher: Iridium
  source: https://api.iridiumhqmcp.com/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)