Clarity Accounts API

The accounts API from Clarity — 15 operation(s) for accounts.

Operations 18

GET /api/v1/accounts Get Account Info #
POST /api/v1/accounts Add User #
GET /api/v1/accounts/status Get Account Status #
GET /api/v1/accounts/projects List Projects #
POST /api/v1/accounts/projects Add Project #
GET /api/v1/accounts/projects/sources List Sources #
POST /api/v1/accounts/projects/sources Add Source #
GET /api/v1/accounts/projects/integrations List Integrations #
GET /api/v1/accounts/projects/integrations/cache List Integrations Cache #
GET /api/v1/accounts/projects/available-sources List Available Sources #
POST /api/v1/accounts/projects/enable Enable Project #
GET /api/v1/accounts/projects/config Get Config #
GET /api/v1/accounts/projects/mcp Get Mcp Config #
POST /api/v1/accounts/settings Update Account Settings #
GET /api/v1/accounts/sources/config Get Onboarding Sources #
POST /api/v1/accounts/sources/{source_id}/pause Pause Source #
POST /api/v1/accounts/sources/{source_id}/resume Resume Source #
POST /api/v1/accounts/sources/{source_id}/engagements Update Source Engagements #

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/onclarity-com:onclarity-com-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

onclarity-com-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fast Accounts API
  version: 0.1.0
tags:
- name: Accounts
paths:
  /api/v1/accounts:
    get:
      tags:
      - Accounts
      summary: Get Account Info
      operationId: get_account_info_api_v1_accounts_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
    post:
      tags:
      - Accounts
      summary: Add User
      operationId: add_user_api_v1_accounts_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/src__service__accounts_manager__AddUserRequest'
        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: []
  /api/v1/accounts/status:
    get:
      tags:
      - Accounts
      summary: Get Account Status
      operationId: get_account_status_api_v1_accounts_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/accounts/projects:
    get:
      tags:
      - Accounts
      summary: List Projects
      operationId: list_projects_api_v1_accounts_projects_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
    post:
      tags:
      - Accounts
      summary: Add Project
      operationId: add_project_api_v1_accounts_projects_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddProjectRequestLocal'
        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: []
  /api/v1/accounts/projects/sources:
    get:
      tags:
      - Accounts
      summary: List Sources
      operationId: list_sources_api_v1_accounts_projects_sources_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
    post:
      tags:
      - Accounts
      summary: Add Source
      operationId: add_source_api_v1_accounts_projects_sources_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddSourceRequestPub'
        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: []
  /api/v1/accounts/projects/integrations:
    get:
      tags:
      - Accounts
      summary: List Integrations
      operationId: list_integrations_api_v1_accounts_projects_integrations_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/accounts/projects/integrations/cache:
    get:
      tags:
      - Accounts
      summary: List Integrations Cache
      operationId: list_integrations_cache_api_v1_accounts_projects_integrations_cache_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/accounts/projects/available-sources:
    get:
      tags:
      - Accounts
      summary: List Available Sources
      operationId: list_available_sources_api_v1_accounts_projects_available_sources_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/accounts/projects/enable:
    post:
      tags:
      - Accounts
      summary: Enable Project
      operationId: enable_project_api_v1_accounts_projects_enable_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/accounts/projects/config:
    get:
      tags:
      - Accounts
      summary: Get Config
      operationId: get_config_api_v1_accounts_projects_config_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/accounts/projects/mcp:
    get:
      tags:
      - Accounts
      summary: Get Mcp Config
      description: 'Return the current project''s MCP server URL and API key.


        The frontend uses these to build the ready-to-paste MCP URL

        (`//`) shown on the Integrations page. The API key is the

        project''s PSK stored in `projects.extra->>''psk''`; it is scoped to the

        caller''s project via the `X-Customer-Name` header.


        The key is a full-power project credential (it also authenticates

        public-api''s ``/public/*`` and ``/inject`` routes), so access is limited to

        project owners and account admins.


        Raises:

        HTTPException: 403 if the user is not an owner or admin.

        HTTPException: 404 if the project has no MCP key configured.'
      operationId: get_mcp_config_api_v1_accounts_projects_mcp_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/McpConfigResponse'
      security:
      - HTTPBearer: []
  /api/v1/accounts/settings:
    post:
      tags:
      - Accounts
      summary: Update Account Settings
      operationId: update_account_settings_api_v1_accounts_settings_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountSettings'
        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: []
  /api/v1/accounts/sources/config:
    get:
      tags:
      - Accounts
      summary: Get Onboarding Sources
      description: Returns the list of onboarding sources from the database.
      operationId: get_onboarding_sources_api_v1_accounts_sources_config_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
  /api/v1/accounts/sources/{source_id}/pause:
    post:
      tags:
      - Accounts
      summary: Pause Source
      operationId: pause_source_api_v1_accounts_sources__source_id__pause_post
      security:
      - HTTPBearer: []
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/accounts/sources/{source_id}/resume:
    post:
      tags:
      - Accounts
      summary: Resume Source
      operationId: resume_source_api_v1_accounts_sources__source_id__resume_post
      security:
      - HTTPBearer: []
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/accounts/sources/{source_id}/engagements:
    post:
      tags:
      - Accounts
      summary: Update Source Engagements
      operationId: update_source_engagements_api_v1_accounts_sources__source_id__engagements_post
      security:
      - HTTPBearer: []
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: string
          title: Source Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSourceEngagementsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    McpConfigResponse:
      properties:
        url:
          type: string
          title: Url
          description: Base MCP server URL, e.g. https://public-api.anecdoteai.com/mcp
        apiKey:
          type: string
          title: Apikey
          description: Per-project pre-shared key used to authenticate the MCP connection
      type: object
      required:
      - url
      - apiKey
      title: McpConfigResponse
      description: Response schema for the project's MCP connection details.
    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
    AddProjectRequestLocal:
      properties:
        name:
          type: string
          title: Name
        slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Slug
      type: object
      required:
      - name
      title: AddProjectRequestLocal
    AddSourceRequestPub:
      properties:
        source:
          type: string
          title: Source
        name:
          type: string
          title: Name
        parameters:
          additionalProperties: true
          type: object
          title: Parameters
      type: object
      required:
      - source
      - name
      - parameters
      title: AddSourceRequestPub
    UpdateSourceEngagementsRequest:
      properties:
        engagement_windows:
          items:
            type: string
          type: array
          title: Engagement Windows
          default: []
      type: object
      title: UpdateSourceEngagementsRequest
    src__service__accounts_manager__AddUserRequest:
      properties:
        create_auth0_user:
          type: boolean
          title: Create Auth0 User
          default: false
        email:
          type: string
          title: Email
        password:
          anyOf:
          - type: string
          - type: 'null'
          title: Password
        full_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Full Name
        is_admin:
          type: boolean
          title: Is Admin
          default: false
      type: object
      required:
      - email
      title: AddUserRequest
    AccountSettings:
      properties:
        domains:
          items:
            anyOf:
            - type: string
            - type: 'null'
          type: array
          title: Domains
          default:
          - []
        is_invite_only:
          type: boolean
          title: Is Invite Only
          default: false
      type: object
      title: AccountSettings
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic