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

# Extract source text

> Step 1 of synthetic setup: turns pasted text, a URL or an uploaded file into readable text, and returns the cost estimate for the synthesis step. No model is called. Files are limited to 4 MB; extracted text is truncated at 60,000 characters.

**Auth:** session. **Permission:** `run_agents` or `manage_agents`.



## OpenAPI

````yaml /api-reference/openapi.json post /projects/{projectId}/synthetic/extract
openapi: 3.1.0
info:
  title: CorePillar API
  version: 1.0.0
  description: >-
    REST API for AgentHub and ModelHub. Ingestion endpoints authenticate with a
    project tracing key; all other endpoints use the signed-in user's browser
    session.
servers:
  - url: https://pillarforge.corepillar.ai/api/v1
    description: AgentHub
security: []
tags:
  - name: Ingestion
    description: 'Send traces with a tracing key: JSON ingest and OpenTelemetry (OTLP).'
  - name: Traces
    description: Read traces and spans.
  - name: Evaluations
    description: Evaluate traces with evaluator collections.
  - name: Evaluators
    description: Built-in and custom evaluators.
  - name: Evaluator collections
    description: Ordered groups of evaluators.
  - name: Organizations
    description: Organizations you belong to.
  - name: Members
    description: Organization members, invites and roles.
  - name: Projects
    description: Projects inside an organization.
  - name: SSO
    description: Okta SSO configuration.
  - name: Tracing keys
    description: Create, list and revoke project tracing keys.
  - name: Cost calculator
    description: Estimate, generate and execute scenario runs.
  - name: Synthetic
    description: Synthetic agent and data setup from source material.
  - name: Chat
    description: ModelHub chat. Served at https://modelhub.corepillar.ai/api/v1.
  - name: Auth
    description: Sign-in helpers.
  - name: E2E
    description: Internal end-to-end encryption key directory.
paths:
  /projects/{projectId}/synthetic/extract:
    post:
      tags:
        - Synthetic
      summary: Extract source text
      description: >-
        Step 1 of synthetic setup: turns pasted text, a URL or an uploaded file
        into readable text, and returns the cost estimate for the synthesis
        step. No model is called. Files are limited to 4 MB; extracted text is
        truncated at 60,000 characters.


        **Auth:** session. **Permission:** `run_agents` or `manage_agents`.
      operationId: syntheticExtract
      parameters:
        - name: projectId
          in: path
          required: true
          description: Project id.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - title: Text
                  type: object
                  required:
                    - kind
                    - text
                  properties:
                    kind:
                      type: string
                      const: text
                    text:
                      type: string
                      minLength: 40
                      maxLength: 200000
                    label:
                      type: string
                      maxLength: 200
                - title: URL
                  type: object
                  required:
                    - kind
                    - url
                  properties:
                    kind:
                      type: string
                      const: url
                    url:
                      type: string
                      minLength: 4
                      maxLength: 2048
                - title: File
                  type: object
                  required:
                    - kind
                    - filename
                    - content_base64
                  properties:
                    kind:
                      type: string
                      const: file
                    filename:
                      type: string
                      minLength: 1
                      maxLength: 200
                    content_base64:
                      type: string
                      description: The file, base64-encoded. Up to 4 MB decoded.
              discriminator:
                propertyName: kind
      responses:
        '200':
          description: Extracted source and estimate.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    properties:
                      source:
                        $ref: '#/components/schemas/ExtractedSource'
                      estimate:
                        type: object
                        additionalProperties: true
        '400':
          description: Validation failed. `error.code` is `VALIDATION_ERROR`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Not signed in (`UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            Not a member of the organization, or missing the required permission
            (`FORBIDDEN`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Project not found or not visible to you (`PROJECT_NOT_FOUND`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '413':
          description: Body or file too large (`VALIDATION_ERROR`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '415':
          description: '`Content-Type` isn''t `application/json` (`VALIDATION_ERROR`).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: >-
            Not enough readable text, unsupported document, or blocked URL
            (`VALIDATION_ERROR`; `details` may include `hint` or `target`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: Unexpected server error (`INTERNAL_ERROR`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - session: []
components:
  schemas:
    ExtractedSource:
      type: object
      required:
        - kind
        - text
      properties:
        kind:
          type: string
          enum:
            - text
            - url
            - file
        label:
          type: string
          maxLength: 2048
          default: Pasted text
        title:
          type: string
          maxLength: 300
          default: ''
        format:
          type: string
          enum:
            - markdown
            - text
            - html
            - docx
            - pdf
            - json
          default: text
        text:
          type: string
          minLength: 1
          maxLength: 60000
        chars:
          type: integer
          minimum: 0
          default: 0
        truncated:
          type: boolean
          default: false
        notes:
          type: array
          maxItems: 10
          items:
            type: string
            maxLength: 500
          default: []
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable code. Branch on this, not on `message`.
              examples:
                - VALIDATION_ERROR
            message:
              type: string
              description: Human-readable description. May change.
            details:
              type: object
              additionalProperties: true
              description: Extra context; often empty.
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: session
      description: >-
        The session cookie set when you sign in to AgentHub or ModelHub in a
        browser. The cookie name shown here is illustrative. There are no API
        tokens for these endpoints.

````

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