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

# Create Extract Config

> Save a config under a name. Later, send its `config_id` to `POST /extract` in place of `config`.



## OpenAPI

````yaml /api-reference/v2/openapi.yml post /extract/configs
openapi: 3.1.0
info:
  title: Pulse API
  description: >-
    Agentic document infrastructure for the enterprise. The Pulse API turns
    complex documents into AI-ready data, such as Markdown, structured JSON and
    bounding boxes.
  version: '2'
servers:
  - url: https://api.runpulse.com
    description: Default Pulse API base URL
security: []
tags:
  - name: Parse
    description: Parse a document's text, tables and figures.
  - name: Batch parse
    description: Parse many documents with one config.
  - name: Extract
    description: Extract structured data from a parsed document.
  - name: Split
    description: Find each topic's pages in a parsed document.
  - name: Tables
    description: Merge a parsed document's tables across pages.
  - name: Charts
    description: Read the charts in a parsed document.
  - name: Classify
    description: Sort a document into the categories you define.
  - name: Pipeline
    description: Run a parse and its follow-on steps as one job.
  - name: Usage
    description: Check the pages and credits your organization has used.
  - name: Webhook
    description: Get notified when your organization's jobs change status.
  - name: Organization settings
    description: Read and change your organization's name, address and default API version.
paths:
  /extract/configs:
    post:
      tags:
        - Extract
      summary: Create Extract Config
      description: >-
        Save a config under a name. Later, send its `config_id` to `POST
        /extract` in place of `config`.
      operationId: createExtractConfig
      parameters:
        - name: Pulse-Version
          in: header
          required: false
          schema:
            type: string
            default: '2'
            title: Pulse-Version
          examples:
            default:
              value: '2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                name:
                  minLength: 1
                  title: Name
                  type: string
                config:
                  $ref: '#/components/schemas/ExtractConfig'
              required:
                - name
                - config
              title: ExtractConfigCreateRequest
              type: object
      responses:
        '201':
          description: The saved config.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtractConfigResponse'
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            The request is invalid
            ([`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-invalid));
            `errors` names each refused field. `Pulse-Version` names a version
            this API doesn't serve
            ([`UNSUPPORTED_VERSION`](https://docs.runpulse.com/errors/unsupported-version)).
          headers:
            X-Request-Id:
              description: The request's id; the problem's `request_id`.
              schema:
                type: string
          x-pulse-errors:
            - REQUEST_INVALID
            - UNSUPPORTED_VERSION
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            No valid credentials
            ([`CREDENTIALS_INVALID`](https://docs.runpulse.com/errors/credentials-invalid)),
            or an inactive API key
            ([`API_KEY_INACTIVE`](https://docs.runpulse.com/errors/api-key-inactive)).
          headers:
            X-Request-Id:
              description: The request's id; the problem's `request_id`.
              schema:
                type: string
          x-pulse-errors:
            - CREDENTIALS_INVALID
            - API_KEY_INACTIVE
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            Your account is suspended
            ([`ACCOUNT_SUSPENDED`](https://docs.runpulse.com/errors/account-suspended)).
          headers:
            X-Request-Id:
              description: The request's id; the problem's `request_id`.
              schema:
                type: string
          x-pulse-errors:
            - ACCOUNT_SUSPENDED
        '404':
          description: >-
            No endpoint answers this path
            ([`ROUTE_NOT_FOUND`](https://docs.runpulse.com/errors/route-not-found)).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          headers:
            X-Request-Id:
              description: The request's id; the problem's `request_id`.
              schema:
                type: string
          x-pulse-errors:
            - ROUTE_NOT_FOUND
        '500':
          description: >-
            An unexpected error on Pulse's side
            ([`SERVER_ERROR`](https://docs.runpulse.com/errors/server-error));
            retry.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          headers:
            X-Request-Id:
              description: The request's id; the problem's `request_id`.
              schema:
                type: string
          x-pulse-errors:
            - SERVER_ERROR
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            A service the request needs couldn't be reached
            ([`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable));
            retry. On a self-hosted install that hasn't been activated yet,
            [`LICENSE_NOT_ACTIVATED`](https://docs.runpulse.com/errors/license-not-activated).
            On a self-hosted install whose license is invalid or expired,
            [`LICENSE_INVALID`](https://docs.runpulse.com/errors/license-invalid).
          headers:
            X-Request-Id:
              description: The request's id; the problem's `request_id`.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: string
          x-pulse-errors:
            - SERVICE_UNAVAILABLE
            - LICENSE_NOT_ACTIVATED
            - LICENSE_INVALID
      security:
        - ApiKey: []
components:
  schemas:
    ExtractConfig:
      additionalProperties: false
      description: Options for extracting structured data from a completed parse.
      properties:
        page_range:
          description: >-
            The pages to read, listed as numbers and ranges from 1, such as
            `1-3, 6, 8-end` (`end` is the last page). Defaults to every page.
            Pages are numbered as in the parse's result.
          pattern: ^ *[0-9]+ *(- *([0-9]+|end) *)?(, *[0-9]+ *(- *([0-9]+|end) *)?)*$
          title: Page Range
          type: string
        prompt:
          description: Extra instructions for filling in `input_schema`.
          minLength: 1
          title: Prompt
          type: string
        input_schema:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          description: >-
            The JSON Schema (Draft 7) to fill in, with an object root, at least
            one property and at most 5,000 properties in all.
          title: Input Schema
          type: object
        effort:
          default: low
          description: '`high` reads the parse more carefully, at an extra charge per page.'
          enum:
            - low
            - high
          title: Effort
          type: string
        confidence:
          default: standard
          description: >-
            `agentic` gives more reliable confidence scores, at an extra charge
            per page. It must be enabled for your organization.
          enum:
            - standard
            - agentic
          title: Confidence
          type: string
        format:
          anyOf:
            - const: all
              type: string
            - items:
                enum:
                  - enriched
                  - raw
                type: string
              type: array
          default:
            - enriched
          description: >-
            `enriched` returns values with citations and confidence, `raw`
            returns the values alone, and `all` returns both.
          title: Format
      required:
        - input_schema
      title: ExtractConfig { page_range, prompt, input_schema, 3 more }
      type: object
    ExtractConfigResponse:
      properties:
        config_id:
          type: string
          title: Config Id
        name:
          type: string
          title: Name
        config:
          $ref: '#/components/schemas/ExtractConfig'
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      additionalProperties: false
      type: object
      required:
        - config_id
        - name
        - config
        - created_at
        - updated_at
      title: ExtractConfigResponse
    Problem:
      additionalProperties: false
      description: >-
        Why the request or the job failed. Branch on `code`; quote `request_id`
        to support.
      properties:
        type:
          description: 'This code''s page: what it means and what to do.'
          title: Type
          type: string
        title:
          description: A short summary of the code, the same for every occurrence.
          title: Title
          type: string
        status:
          description: The HTTP status the code answers with.
          title: Status
          type: integer
        detail:
          description: What happened this time.
          title: Detail
          type: string
        instance:
          description: 'This occurrence: the request''s URN, `urn:pulse:request:<id>`.'
          title: Instance
          type: string
        code:
          description: The stable error code, e.g. `REQUEST_INVALID`. Branch on it.
          title: Code
          type: string
        request_id:
          description: >-
            The request that failed, as `X-Request-Id` named it; for a failed
            job, the request that created it. Quote it to support.
          title: Request Id
          type: string
        retryable:
          description: Whether the same request may succeed if sent again.
          title: Retryable
          type: boolean
        retry_after:
          description: Seconds to wait before retrying, as `Retry-After` says.
          title: Retry After
          type: integer
        errors:
          description: Each refused part of the request.
          items:
            $ref: '#/components/schemas/FieldIssue'
          title: Errors
          type: array
        resource:
          description: 'What wasn''t found: `job`, `batch`, `webhook`, `config`, …'
          title: Resource
          type: string
        reason:
          description: The cause within the code.
          title: Reason
          type: string
        parse_id:
          description: The parse the request recorded.
          title: Parse Id
          type: string
        extract_id:
          description: The extraction it recorded.
          title: Extract Id
          type: string
        split_id:
          description: The split it recorded.
          title: Split Id
          type: string
        classify_id:
          description: The classification it recorded.
          title: Classify Id
          type: string
        tables_id:
          description: The tables job it recorded.
          title: Tables Id
          type: string
        charts_id:
          description: The charts job it recorded.
          title: Charts Id
          type: string
        pipeline_id:
          description: The pipeline it recorded.
          title: Pipeline Id
          type: string
        batch_id:
          description: The batch it recorded.
          title: Batch Id
          type: string
        filename:
          description: The file refused.
          title: Filename
          type: string
        declared_type:
          description: The type its name declared.
          title: Declared Type
          type: string
        detected:
          description: The type its contents are.
          title: Detected
          type: string
        supported_types:
          description: The types accepted.
          items:
            type: string
          title: Supported Types
          type: array
        supported:
          description: The values accepted.
          items:
            type: string
          title: Supported
          type: array
        max_size_mb:
          anyOf:
            - type: integer
            - type: number
          description: The largest size accepted.
          title: Max Size Mb
        file_size_mb:
          anyOf:
            - type: integer
            - type: number
          description: The file's size.
          title: File Size Mb
        plan_name:
          description: Your organization's plan.
          title: Plan Name
          type: string
        pages_used:
          anyOf:
            - type: integer
            - type: number
          description: Pages used this period.
          title: Pages Used
        page_allowance:
          anyOf:
            - type: integer
            - type: number
          description: Pages the plan allows.
          title: Page Allowance
        upgrade_url:
          description: Where to change your plan.
          title: Upgrade Url
          type: string
        action_required:
          description: What to do to continue.
          title: Action Required
          type: string
        billing_info:
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
          description: Your organization's billing state, as the gate read it.
          title: Billing Info
          type: object
      required:
        - type
        - title
        - status
        - code
        - retryable
      title: Problem
      type: object
    JsonValue: {}
    FieldIssue:
      additionalProperties: false
      description: One refused part of the request.
      properties:
        field:
          description: >-
            The part as sent: a body field's path
            (`config.enhancements.detect[1]`), or `query.<name>` /
            `header.<name>`.
          title: Field
          type: string
        pointer:
          description: >-
            A body field as a JSON Pointer (RFC 6901), e.g.
            `#/config/enhancements/detect/1`. Absent for a query parameter or
            header.
          title: Pointer
          type: string
        issue:
          description: What is wrong with it.
          title: Issue
          type: string
      required:
        - field
        - issue
      title: FieldIssue
      type: object
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key

````

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