> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Check the Anthropic key

> Ask Anthropic whether the workspace's key works now: a run checks it before it starts. A key Anthropic answered as working in the last minute is answered as it stands, without asking again. A key that works again lets the rows it stopped run with Run failed rows. Anyone in the workspace may check; only a workspace admin's check with record=true adds an entry to the key's history, and record=false (a run's check) never does.



## OpenAPI

````yaml /openapi.json post /provider-keys/claude/verify/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: >-
      The docked AI Assistant: its general chat about the workspace and the
      product, streamed as Server-Sent Events, and the one list of a person's
      threads across every assistant, with pin, rename, delete and the
      search-to-table link, and the read of a web page a person links.
    name: assistant
  - description: >-
      The messages a person keeps to send the assistant again: the ones the
      workspace saved and the ones that ship with the product, with save,
      rename, edit and delete.
    name: assistant-prompt
  - description: >-
      Granted workspace actions: what the AI Assistant proposed or applied in a
      conversation, the approve and dismiss decisions on each card, the
      workspace's spend threshold and default grants, and the eight verbs.
    name: workspace-actions
  - description: >-
      The Getting started checklist: a workspace's progress through the six
      steps from its first people search to its first launched sequence.
    name: onboarding
  - description: Senders, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: >-
      The workspace's recontact rule: how long before anyone hears from us
      again.
    name: contact_cooldown
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The outbound agent behind a sequence: the voice it writes in, its
      per-message prompts, what it wrote and what people told it.
    name: outbound-agents
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: >-
      The approval queue: everything waiting on a person across every sender and
      channel, and the workspace's manual or automatic modes per channel.
    name: outreach
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for listing, checking and deleting integrations.
    name: integrations
  - description: >-
      Create, preview and update an integration of any type: the body's
      integration_type picks the config and credentials it takes.
    name: integration-specific
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: >-
      AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any
      other MCP client a person signed in to Oneprofile's MCP server with.
    name: ai_apps
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: >-
      Accounts: every company the workspace's tables name, with the people at
      it, its key facts, its tables, its org chart and what went to its people;
      the tables that feed it (Sources) and the merges a person made.
    name: accounts
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and color tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organization calls each color. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for an agent's Preview: example rows run one at a time, and a
      Looks good on each. Needs work lives under agent-learnings.
    name: agent-training
  - description: >-
      An agent's learnings, the one-line rules it follows on every output, and
      the thumbs down that teaches them: give one with what was wrong, list the
      ones on a subject, Undo one, and price the redo it would run.
    name: agent-learnings
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      Endpoints for PER-USER table preferences: favorites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organization legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for the webhook URL an app or a tool of your own sends records
      to: what can send them, make the URL, show it again, replace it, revoke
      it, save the app's secrets, resume a paused feed, and read and retry the
      deliveries that did not fit.
    name: table-webhooks
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches. Alongside people
      and company searches, leads can be sourced from buying signals (what a
      company or person just did), with a catalog endpoint behind the picker
      that builds them.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the affiliate program's own dashboard: enrolling and
      claiming a code, the summary, stats and activity feed, the commission
      ledger, and identity verification and payouts.
    name: affiliate
  - description: >-
      Endpoints for recording where a new workspace came from: the marketing
      page or campaign its signup link carried, sent once after signup.
    name: attribution
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context (company description,
      ideal customer profile, buyer personas, interest signals and social
      proof), plus domain-based generation and the reference documents whose
      summaries ride alongside those fields.
    name: ai-context
  - description: >-
      Endpoints for the signed-in user's Google Drive connection: starting and
      finishing the OAuth grant, checking or dropping it, and minting the
      short-lived token the Google Picker needs.
    name: google-drive
paths:
  /provider-keys/claude/verify/:
    post:
      tags:
        - provider-keys
      summary: Check the Anthropic key
      description: >-
        Ask Anthropic whether the workspace's key works now: a run checks it
        before it starts. A key Anthropic answered as working in the last minute
        is answered as it stands, without asking again. A key that works again
        lets the rows it stopped run with Run failed rows. Anyone in the
        workspace may check; only a workspace admin's check with record=true
        adds an entry to the key's history, and record=false (a run's check)
        never does.
      operationId: verify_claude_key
      parameters:
        - in: query
          name: record
          required: false
          schema:
            default: true
            title: Record
            type: boolean
        - in: query
          name: key_id
          required: false
          schema:
            anyOf:
              - format: uuid
                type: string
              - type: 'null'
            title: Key Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaudeKeyReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: This workspace has no Anthropic key.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    ClaudeKeyReadSchema:
      description: >-
        The workspace's own Anthropic keys and how its paid AI work uses them.


        Never a key: its last four characters. With a key, the AI work that
        costs credits (the

        areas switched on) runs on one of the working keys, picked at random,
        and a row costs the

        key fee plus the web pages it read.
      properties:
        can_change:
          description: 'Whether the caller may add, replace, pause or remove keys: admins.'
          title: Can Change
          type: boolean
        key:
          anyOf:
            - $ref: '#/components/schemas/ClaudeKeyEntrySchema'
            - type: 'null'
          description: >-
            The key that stands for them all: a working one when any works, so
            the keys stop AI work only when this one has stopped. Null when none
            is connected.
        key_fee_credits:
          description: What a row on the key costs here, in credits.
          title: Key Fee Credits
          type: number
        keys:
          description: >-
            Every key, oldest first. Each piece of AI work runs on a working
            one.
          items:
            $ref: '#/components/schemas/ClaudeKeyEntrySchema'
          title: Keys
          type: array
        limit_lifts_at:
          description: >-
            When the month ends (midnight UTC on the next month's first day),
            and with it a reached limit: the moment held AI work on the keys
            starts again.
          format: date-time
          title: Limit Lifts At
          type: string
        limit_reached:
          description: >-
            Whether this month reached the limit: AI work on the key waits until
            limit_lifts_at.
          title: Limit Reached
          type: boolean
        max_keys:
          description: The most Anthropic keys a workspace may hold.
          title: Max Keys
          type: integer
        month:
          $ref: '#/components/schemas/ClaudeKeyMonthSchema'
        monthly_limit_usd:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            AI work on the key stops for the month once our estimate of its
            Anthropic bill reaches this many dollars; null for no limit.
          title: Monthly Limit Usd
        paid:
          description: 'Whether the workspace is on a paid plan: the key needs one.'
          title: Paid
          type: boolean
        paused:
          description: True pays all AI work with credits until resumed.
          title: Paused
          type: boolean
        requests_per_minute:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The account's request limit a minute, as Anthropic said at the last
            check.
          title: Requests Per Minute
        slow:
          description: >-
            Whether that limit is a new Anthropic account's: big runs go slower
            for now.
          title: Slow
          type: boolean
        use_for_columns:
          description: AI columns that answer from the model alone.
          title: Use For Columns
          type: boolean
        use_for_research:
          description: 'Research cells: an AI column with web research, Enrich job, agents.'
          title: Use For Research
          type: boolean
        use_for_writing:
          description: Sequence steps and replies the agent writes.
          title: Use For Writing
          type: boolean
      required:
        - key
        - keys
        - max_keys
        - paid
        - paused
        - use_for_columns
        - use_for_research
        - use_for_writing
        - monthly_limit_usd
        - requests_per_minute
        - slow
        - month
        - limit_reached
        - limit_lifts_at
        - key_fee_credits
        - can_change
      title: ClaudeKeyReadSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    ClaudeKeyEntrySchema:
      description: >-
        One of the workspace's Anthropic keys, who added it, and what it carried
        this month.
      properties:
        added_by_display_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Who added the key, by name; null when unknown.
          title: Added By Display Name
        checked_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the provider last answered a check.
          title: Checked At
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By User Id
        credits_remaining:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            The provider's own balance on the key at the last check, in the
            provider's units; null for a provider that does not report one.
          title: Credits Remaining
        health:
          $ref: '#/components/schemas/ProviderKeyHealth'
          description: >-
            unchecked (saved while the provider could not be reached), healthy,
            out_of_credits or invalid (the provider refused it).
        health_detail:
          anyOf:
            - type: string
            - type: 'null'
          description: Why the key is not healthy, when it is not.
          title: Health Detail
        id:
          format: uuid
          title: Id
          type: string
        integration_type:
          description: The provider.
          title: Integration Type
          type: string
        key_hint:
          description: The key's last four characters.
          title: Key Hint
          type: string
        month_cost_usd:
          default: 0
          description: >-
            Our estimate of what Anthropic billed this key for them, at its list
            prices: what this key's own Anthropic account sees.
          title: Month Cost Usd
          type: number
        month_rows:
          default: 0
          description: Pieces of work that ran on this key this calendar month (UTC).
          title: Month Rows
          type: integer
        provider_name:
          description: The provider's name.
          title: Provider Name
          type: string
        running_low:
          description: >-
            Whether a working key has fewer of the provider's own credits left
            than the mark at which the workspace is told it is running low.
          title: Running Low
          type: boolean
        updated_at:
          format: date-time
          title: Updated At
          type: string
        updated_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated By User Id
      required:
        - id
        - integration_type
        - provider_name
        - key_hint
        - health
        - health_detail
        - checked_at
        - credits_remaining
        - running_low
        - created_by_user_id
        - updated_by_user_id
        - created_at
        - updated_at
        - added_by_display_name
      title: ClaudeKeyEntrySchema
      type: object
    ClaudeKeyMonthSchema:
      description: What AI work on the key cost this calendar month (UTC).
      properties:
        cost_usd:
          description: >-
            Our estimate of what Anthropic billed the key for them, at its list
            prices.
          title: Cost Usd
          type: number
        month:
          description: The month's first day.
          format: date
          title: Month
          type: string
        rows:
          description: Pieces of work (a cell, a written step) that ran on the key.
          title: Rows
          type: integer
      required:
        - month
        - rows
        - cost_usd
      title: ClaudeKeyMonthSchema
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
    ProviderKeyHealth:
      description: >-
        Where a workspace's own key with one provider stands, as the last check
        found it.


        Owned here, below the key store, because the chain reads it to decide
        what

        a step on that key does: a healthy (or not yet checked) key is called,
        an

        out-of-credits or rejected key is skipped and the trail says why. The
        key

        store's lifecycle moves a key between these states.
      enum:
        - unchecked
        - healthy
        - out_of_credits
        - invalid
      title: ProviderKeyHealth
      type: string
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.