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

# Run a bulk batch

> Extracts criteria from up to 10 job descriptions and runs each as its own search, two pipelines in flight at a time. Returns immediately with a `batchId`.

One bad job description fails its own search and never the batch.



## OpenAPI

````yaml /openapi.json post /api/bulk
openapi: 3.1.0
info:
  title: Revcenter API
  description: >-
    Search, enrich, and activate people and companies. Two authentication
    surfaces share one host: the bearer-token API under `/v1` for
    server-to-server and agent use, and the workspace-session API under `/api`
    that the Revcenter app itself runs on.
  version: '2026-08-12'
servers:
  - url: https://api.revcenter.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search
    description: Web search, search runs, results, exports, and shareable shortlists.
  - name: People
    description: Person search, profile enrichment, and the workspace contact pool.
  - name: Companies
    description: Company search, company enrichment, and org-chart people.
  - name: Campaigns
    description: Plan, publish, and launch outbound sequences on Smartlead and HeyReach.
  - name: Account
    description: Health, usage totals, and cost events.
paths:
  /api/bulk:
    post:
      tags:
        - Search
      summary: Run a bulk batch
      description: >-
        Extracts criteria from up to 10 job descriptions and runs each as its
        own search, two pipelines in flight at a time. Returns immediately with
        a `batchId`.


        One bad job description fails its own search and never the batch.
      operationId: createBulkBatch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                items:
                  type: array
                  minItems: 1
                  maxItems: 10
                  description: >-
                    Job descriptions. Entries shorter than 12 characters are
                    dropped before the cap is applied.
                  items:
                    type: object
                    required:
                      - text
                    properties:
                      text:
                        type: string
                        minLength: 12
                        description: The job description.
                      label:
                        type: string
                        description: >-
                          Title for the resulting search. Falls back to the
                          first 120 characters of `text`.
                mode:
                  $ref: '#/components/schemas/ScanMode'
                model:
                  $ref: '#/components/schemas/ExtractModel'
            examples:
              twoRoles:
                summary: Two roles in one batch
                value:
                  items:
                    - label: Clinic Manager — Lévis
                      text: >-
                        Clinic manager in Lévis, Québec. French required. 5+
                        years running a multi-site clinic.
                    - label: Wealth Advisor — San Jose
                      text: >-
                        Wealth advisor, San Jose. CFP preferred, 7+ years, book
                        of business.
      responses:
        '201':
          description: The batch was queued.
          content:
            application/json:
              schema:
                type: object
                properties:
                  batchId:
                    type: string
                    format: uuid
                  queued:
                    type: integer
                    description: How many job descriptions were accepted.
        '400':
          $ref: '#/components/responses/AppBadRequest'
        '401':
          $ref: '#/components/responses/AppUnauthorized'
        '424':
          $ref: '#/components/responses/AppProviderUnavailable'
        '502':
          $ref: '#/components/responses/AppUpstreamError'
      security:
        - sessionCookie: []
components:
  schemas:
    ScanMode:
      type: string
      enum:
        - candidate
        - client
      default: candidate
      description: >-
        `candidate` searches for people against a role. `client` discovers
        target companies first, then their decision-makers.
    ExtractModel:
      type: string
      enum:
        - claude-haiku-4-5
        - claude-sonnet-5
        - claude-opus-5
      description: >-
        Which model extracts criteria. Anything outside this allowlist is
        rejected. Omit to use the workspace default.
    AppError:
      type: object
      description: >-
        The error shape used by every `/api` endpoint. Flatter than the `/v1`
        shape, and `code` appears only where the UI branches on it.
      properties:
        error:
          type: string
        code:
          type: string
          examples:
            - search_unavailable
  responses:
    AppBadRequest:
      description: Missing or invalid input.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            missing:
              value:
                error: criteria (CriteriaV2) is required
    AppUnauthorized:
      description: >-
        Not signed in, no active workspace, or the account lacks the role this
        action needs. A frozen account gets `403` with code `frozen`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            signIn:
              value:
                error: Sign in required
    AppProviderUnavailable:
      description: >-
        A capability this action needs is not connected for the workspace. The
        `code` names which one.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            search:
              value:
                error: Search is unavailable for this workspace.
                code: search_unavailable
            scoring:
              value:
                error: AI scoring is unavailable for this workspace.
                code: ai_scoring_unavailable
            heyreach:
              value:
                error: No HeyReach API key configured — add one in Credentials.
                code: heyreach_not_configured
    AppUpstreamError:
      description: A downstream service or the database failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            upstream:
              value:
                error: Spec extraction failed
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Revcenter API key: `Authorization: Bearer rvc_live_...`. Keys are
        scoped, rate limited per key, and metered per workspace.
    sessionCookie:
      type: apiKey
      in: cookie
      name: session
      description: >-
        A signed-in workspace session, sent as a browser cookie. Requests must
        include credentials, and act on the session's active workspace.

````