> ## 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.

# Generate an enrichment column draft

> Turn one plain-language sentence into a draft AI-column configuration — display name, prompt with column references, output fields and a model suggestion. The draft seeds the editor and is not saved.



## OpenAPI

````yaml /openapi.json post /table-enrichments/generate/
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: Sender profiles, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - 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 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 creating and managing integrations.
    name: integrations
  - 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: Endpoints for managing billing and subscription information.
    name: billing
  - 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 colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. 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 teaching a saved agent from example rows: training sessions,
      per-row feedback, and the proposed prompt to approve.
    name: agent-training
  - 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: >-
      The per-table AI Assistant: named conversations, the column suggestions a
      build turn produces, and the questions an analyze turn answers.
    name: table-assistant
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation 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 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.
    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 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 and interest signals — plus
      domain-based generation.
    name: ai-context
paths:
  /table-enrichments/generate/:
    post:
      tags:
        - table-enrichments
      summary: Generate an enrichment column draft
      description: >-
        Turn one plain-language sentence into a draft AI-column configuration —
        display name, prompt with column references, output fields and a model
        suggestion. The draft seeds the editor and is not saved.
      operationId: generate_enrichment_column
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateEnrichmentColumnRequestSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrichmentColumnDraftSchema'
          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: Table not found
        '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:
        - HTTPBearer: []
        - APIKeyHeader: []
components:
  schemas:
    GenerateEnrichmentColumnRequestSchema:
      description: One sentence to turn into a draft AI-column configuration.
      properties:
        instruction:
          description: A plain-language description of the column to build.
          maxLength: 2000
          minLength: 1
          title: Instruction
          type: string
        table_id:
          description: The table whose columns the prompt may reference.
          format: uuid
          title: Table Id
          type: string
      required:
        - table_id
        - instruction
      title: GenerateEnrichmentColumnRequestSchema
      type: object
    EnrichmentColumnDraftSchema:
      description: A generated draft configuration that seeds the column editor.
      properties:
        action_key:
          title: Action Key
          type: string
        display_name:
          title: Display Name
          type: string
        model_key:
          anyOf:
            - type: string
            - type: 'null'
          description: The suggested model; null keeps the catalog default.
          title: Model Key
        output:
          discriminator:
            mapping:
              fields:
                $ref: '#/components/schemas/EnrichmentOutputFields-Output'
              json_schema:
                $ref: '#/components/schemas/EnrichmentOutputRawSchema'
            propertyName: mode
          oneOf:
            - $ref: '#/components/schemas/EnrichmentOutputFields-Output'
            - $ref: '#/components/schemas/EnrichmentOutputRawSchema'
          title: Output
        prompt:
          $ref: '#/components/schemas/EnrichmentPromptTemplate'
          description: The drafted prompt, with references to existing columns.
        web_research:
          description: >-
            Whether the drafted task needs live web research. Always false for
            actions other than Use AI, which is the only one with a web-research
            switch to prefill.
          title: Web Research
          type: boolean
      required:
        - display_name
        - action_key
        - prompt
        - output
        - model_key
        - web_research
      title: EnrichmentColumnDraftSchema
      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
    EnrichmentOutputFields-Output:
      description: |-
        The fields-mode output shape: repeatable named typed fields.

        The default is Clay's: one text field named ``response``.
      properties:
        fields:
          items:
            $ref: '#/components/schemas/EnrichmentOutputField'
          maxItems: 20
          minItems: 1
          title: Fields
          type: array
        mode:
          const: fields
          default: fields
          title: Mode
          type: string
      title: EnrichmentOutputFields
      type: object
    EnrichmentOutputRawSchema:
      description: >-
        The advanced output shape: a raw strict-mode JSON schema, verbatim.


        Held to every strict-mode constraint at SAVE time by the service layer —

        the shape is stored exactly as authored, and validation failures name
        the

        exact violated rule rather than surfacing at run time.
      properties:
        json_schema:
          additionalProperties: true
          description: A strict-mode JSON schema with an object root.
          title: Json Schema
          type: object
        mode:
          const: json_schema
          default: json_schema
          title: Mode
          type: string
      required:
        - json_schema
      title: EnrichmentOutputRawSchema
      type: object
    EnrichmentPromptTemplate:
      description: >-
        The persisted prompt: an ordered mix of text and column references.


        Resolution to a per-row string happens at run time; the segment list is

        the single source of truth the editor renders pills from and the
        executor

        substitutes values into.
      properties:
        format:
          default: plain
          description: >-
            How the editor reads text segments: 'markdown' renders them as
            markdown source, 'plain' verbatim. Templates saved before the field
            existed carry no value and default to 'plain', the safe reading.
            Purely editor metadata — run-time resolution concatenates text
            segments identically either way.
          enum:
            - plain
            - markdown
          title: Format
          type: string
        segments:
          items:
            discriminator:
              mapping:
                column_ref:
                  $ref: '#/components/schemas/EnrichmentPromptColumnRefSegment'
                text:
                  $ref: '#/components/schemas/EnrichmentPromptTextSegment'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/EnrichmentPromptTextSegment'
              - $ref: '#/components/schemas/EnrichmentPromptColumnRefSegment'
          maxItems: 100
          title: Segments
          type: array
      title: EnrichmentPromptTemplate
      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
    EnrichmentOutputField:
      description: |-
        One named, typed value an enrichment run returns.

        Field types are drawn from the platform's existing column types, so any
        single field can later be promoted into an ordinary typed column without
        inventing a new type system.
      properties:
        choices:
          anyOf:
            - items:
                type: string
              maxItems: 200
              type: array
            - type: 'null'
          description: The fixed option list for a select field; None elsewhere.
          title: Choices
        description:
          anyOf:
            - maxLength: 500
              type: string
            - type: 'null'
          description: 'Shown to the model: what this field should contain.'
          title: Description
        field_type:
          $ref: '#/components/schemas/TableColumnType'
          default: text
        name:
          maxLength: 100
          minLength: 1
          title: Name
          type: string
      required:
        - name
      title: EnrichmentOutputField
      type: object
    EnrichmentPromptColumnRefSegment:
      description: |-
        An inline reference to another column's per-row value.

        Stored by column IDENTITY, never by display name — renaming a column can
        never change what a prompt means, and a deleted column is detectable
        rather than silently resolving to nothing.
      properties:
        column_id:
          format: uuid
          title: Column Id
          type: string
        path:
          anyOf:
            - maxLength: 300
              type: string
            - type: 'null'
          description: >-
            Dot-separated address of a sub-value inside a structured cell —
            output field names and zero-based list indices, e.g.
            'competitors.0'. None references the whole cell. Emptiness for the
            required rule is judged on the addressed sub-value.
          title: Path
        required:
          default: true
          description: >-
            Whether a row whose value for this column is empty is skipped
            entirely instead of run with a blank substituted.
          title: Required
          type: boolean
        type:
          const: column_ref
          default: column_ref
          title: Type
          type: string
      required:
        - column_id
      title: EnrichmentPromptColumnRefSegment
      type: object
    EnrichmentPromptTextSegment:
      description: A literal run of prompt text.
      properties:
        text:
          maxLength: 20000
          title: Text
          type: string
        type:
          const: text
          default: text
          title: Type
          type: string
      required:
        - text
      title: EnrichmentPromptTextSegment
      type: object
    TableColumnType:
      description: >-
        The type a user picks for a table column.


        Ordered as the picker shows them, which is also the order the groups
        below

        run in: text-ish, then numeric, then choice, then structured.
      enum:
        - text
        - paragraph
        - url
        - email
        - image_url
        - person
        - select
        - number
        - decimal
        - currency
        - checkbox
        - date
        - multi_select
        - list
        - object
      title: TableColumnType
      type: string
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````