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

# Run a record's AI auto-fills

> Run a record's configured AI auto-fills — loads every enabled Property Agent on the record's object and runs them in dependency order, writing the AI-filled properties. **Requires scope:** `records:write`.



## OpenAPI

````yaml /openapi-v1.json post /v1/records/{object}/{id}/enrich
openapi: 3.1.0
info:
  title: Custral API
  version: v1
  description: >-
    The curated, versioned, API-key-authenticated public REST surface (`/v1`).
    Every endpoint here is what the official SDKs (`@custral/sdk`) and the MCP
    server are built on. Authenticate with a secret API key (`sk_…`) created in
    **Settings → Applications**.
  contact:
    name: Custral Support
    email: hello@custral.com
    url: https://custral.com
  license:
    name: Proprietary
    url: https://custral.com
servers:
  - url: https://api.custral.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Introspect the calling API key.
  - name: Records
    description: Create, list, retrieve, and update records on any object.
  - name: Objects
    description: Read the object (table) schema of your workspace.
  - name: Conversations
    description: View, manage, and ingest conversations and their messages.
  - name: MCP
    description: Introspect the Model Context Protocol tool surface for a key.
  - name: Documents
    description: Read record notes / page documents as markdown.
paths:
  /v1/records/{object}/{id}/enrich:
    post:
      tags:
        - Records
      summary: Run a record's AI auto-fills
      description: >-
        Run a record's configured AI auto-fills — loads every enabled Property
        Agent on the record's object and runs them in dependency order, writing
        the AI-filled properties. **Requires scope:** `records:write`.
      operationId: enrichRecord
      parameters:
        - name: object
          in: path
          required: true
          description: The object — its id, key, or name.
          schema:
            type: string
          example: contacts
        - name: id
          in: path
          required: true
          description: The record id (`rec_…`).
          schema:
            type: string
          example: rec_123
      responses:
        '200':
          description: The enrichment run summary.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EnrichmentResult'
                  reqId:
                    $ref: '#/components/schemas/RequestId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    EnrichmentResult:
      type: object
      description: The result of running a record's configured AI auto-fills.
      properties:
        recordId:
          type: string
          example: rec_123
        objectId:
          type: string
          example: obj_123
        total:
          type: integer
          description: Total steps run.
        succeeded:
          type: integer
        failed:
          type: integer
        skipped:
          type: integer
        steps:
          type: array
          items:
            type: object
            properties:
              propertyId:
                type:
                  - string
                  - 'null'
                example: prop_123
              propertyAgentId:
                type:
                  - string
                  - 'null'
                example: pagent_123
              status:
                type: string
                enum:
                  - success
                  - failed
                  - skipped
                example: success
              errorMessage:
                type:
                  - string
                  - 'null'
                description: The failure / skip reason, when not success.
              durationMs:
                type: integer
      required:
        - recordId
        - objectId
        - total
        - steps
    RequestId:
      type: string
      description: >-
        A per-request id (`req_…`). Quote it to support when reporting a
        problem.
      example: req_2a1f9c8e7b6d5
    Error:
      type: object
      description: >-
        The failure envelope. Every error carries a machine-readable `code` and
        the `reqId` of the failing request.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: insufficient_scope
          required:
            - code
        reqId:
          $ref: '#/components/schemas/RequestId'
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        The API key is missing, unknown, inactive, or expired (`code:
        invalid_api_key`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
            reqId: req_2a1f9c8e7b6d5
    Forbidden:
      description: >-
        The key lacks the scope this endpoint requires (`code:
        insufficient_scope`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_scope
            reqId: req_2a1f9c8e7b6d5
    NotFound:
      description: 'The object or record was not found (`code: not_found`).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
            reqId: req_2a1f9c8e7b6d5
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: sk_...
      description: >-
        A Custral **secret** API key (`sk_…`), created in Settings →
        Applications. Sent as `Authorization: Bearer sk_…`. The `X-Api-Key:
        sk_…` header is also accepted and takes precedence. Never expose a
        secret key in a browser.

````

## Related topics

- [AI](/ai/overview.md)
- [Property Auto-Fill Agents](/ai/property-agents/overview.md)
- [Triggers](/ai/property-agents/triggers.md)
- [The Property Agent object](/dev/api-reference/property-agents.md)
- [List auto-fill agents](/api-reference/property-agents/list-auto-fill-agents.md)