LlamaParse Parse API

The core document parsing API that converts PDFs and 130+ file formats into structured markdown, text, and layout-aware output for LLM and RAG pipelines. Supports tier selection (fast, cost-effective, agentic, agentic-plus) with versioned, reproducible parsing behavior via the v2 endpoint.

OpenAPI Specification

llamaparse-llamacloud-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Llama Platform
  version: 0.1.0
paths:
  /api/v1/data-sinks:
    get:
      tags:
      - Data Sinks
      summary: List Data Sinks
      description: List data sinks for a given project.
      operationId: list_data_sinks_api_v1_data_sinks_get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataSink'
                title: Response List Data Sinks Api V1 Data Sinks Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Data Sinks
      summary: Create Data Sink
      description: Create a new data sink.
      operationId: create_data_sink_api_v1_data_sinks_post
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSinkCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSink'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/data-sinks/{data_sink_id}:
    get:
      tags:
      - Data Sinks
      summary: Get Data Sink
      description: Get a data sink by ID.
      operationId: get_data_sink_api_v1_data_sinks__data_sink_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: data_sink_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Sink Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSink'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Data Sinks
      summary: Update Data Sink
      description: Update a data sink by ID.
      operationId: update_data_sink_api_v1_data_sinks__data_sink_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: data_sink_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Sink Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSinkUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSink'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Data Sinks
      summary: Delete Data Sink
      description: Delete a data sink by ID.
      operationId: delete_data_sink_api_v1_data_sinks__data_sink_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: data_sink_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Sink Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/data-sources:
    get:
      tags:
      - Data Sources
      summary: List Data Sources
      description: 'List data sources for a given project.

        If project_id is not provided, uses the default project.'
      operationId: list_data_sources_api_v1_data_sources_get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataSource'
                title: Response List Data Sources Api V1 Data Sources Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Data Sources
      summary: Create Data Source
      description: Create a new data source.
      operationId: create_data_source_api_v1_data_sources_post
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/data-sources/{data_source_id}:
    get:
      tags:
      - Data Sources
      summary: Get Data Source
      description: Get a data source by ID.
      operationId: get_data_source_api_v1_data_sources__data_source_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: data_source_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Source Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Data Sources
      summary: Update Data Source
      description: Update a data source by ID.
      operationId: update_data_source_api_v1_data_sources__data_source_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: data_source_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Source Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataSourceUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Data Sources
      summary: Delete Data Source
      description: Delete a data source by ID.
      operationId: delete_data_source_api_v1_data_sources__data_source_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: data_source_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Data Source Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/embedding-model-configs:
    get:
      tags:
      - Embedding Model Configs
      summary: List Embedding Model Configs
      operationId: list_embedding_model_configs_api_v1_embedding_model_configs_get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmbeddingModelConfig'
                title: Response List Embedding Model Configs Api V1 Embedding Model
                  Configs Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Embedding Model Configs
      summary: Create a new Embedding Model Configuration
      description: Create a new embedding model configuration within a specified project.
      operationId: create_embedding_model_config_api_v1_embedding_model_configs_post
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddingModelConfigCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingModelConfig'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/embedding-model-configs/{embedding_model_config_id}:
    put:
      tags:
      - Embedding Model Configs
      summary: Update Embedding Model Config
      description: Update an embedding model config by ID.
      operationId: update_embedding_model_config_api_v1_embedding_model_configs__embedding_model_config_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: embedding_model_config_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Embedding Model Config Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddingModelConfigUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingModelConfig'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Embedding Model Configs
      summary: Delete Embedding Model Config
      description: Delete an embedding model config by ID.
      operationId: delete_embedding_model_config_api_v1_embedding_model_configs__embedding_model_config_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: embedding_model_config_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Embedding Model Config Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/organizations:
    get:
      tags:
      - Organizations
      summary: List Organizations
      description: List organizations for a user.
      operationId: list_organizations_api_v1_organizations_get
      security:
      - HTTPBearer: []
      parameters:
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Organization'
                title: Response List Organizations Api V1 Organizations Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/organizations/{organization_id}:
    get:
      tags:
      - Organizations
      summary: Get Organization
      description: Get an organization by ID.
      operationId: get_organization_api_v1_organizations__organization_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/projects:
    get:
      tags:
      - Projects
      summary: List Projects
      description: List projects or get one by name
      operationId: list_projects_api_v1_projects_get
      security:
      - HTTPBearer: []
      parameters:
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: project_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Name
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
                title: Response List Projects Api V1 Projects Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/projects/{project_id}:
    get:
      tags:
      - Projects
      summary: Get Project
      description: Get a project by ID.
      operationId: get_project_api_v1_projects__project_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/job-data-points:
    get:
      tags:
      - Job Dashboard
      summary: Query project job data points
      description: Returns paginated job data points for the current project.
      operationId: list_project_job_data_points_api_v1_job_data_points_get
      security:
      - HTTPBearer: []
      parameters:
      - name: job_type
        in: query
        required: true
        schema:
          enum:
          - extract
          - parse
          - classify
          type: string
          description: Job type to query.
          examples:
          - parse
          title: Job Type
        description: Job type to query.
      - name: hours
        in: query
        required: false
        schema:
          type: integer
          maximum: 168
          minimum: 1
          description: Hours of history to include.
          examples:
          - 24
          default: 1
          title: Hours
        description: Hours of history to include.
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter by status.
          examples:
          - - completed
            - failed
          title: Status
        description: Filter by status.
      - name: page_size
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Number of items per page.
          examples:
          - 100
          title: Page Size
        description: Number of items per page.
      - name: page_token
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Cursor token for the next page.
          title: Page Token
        description: Cursor token for the next page.
      - name: created_at_on_or_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Include items created at or after this timestamp (inclusive)
          title: Created At On Or After
        description: Include items created at or after this timestamp (inclusive)
      - name: created_at_on_or_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Include items created at or before this timestamp (inclusive)
          title: Created At On Or Before
        description: Include items created at or before this timestamp (inclusive)
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDataPointResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/files/{id}/page_screenshots:
    get:
      tags:
      - Page Screenshots
      summary: List File Page Screenshots
      description: List metadata for all screenshots of pages from a file.
      operationId: list_file_page_screenshots_api_v1_files__id__page_screenshots_get
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PageScreenshotMetadata'
                title: Response List File Page Screenshots Api V1 Files  Id  Page
                  Screenshots Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/files/{id}/page_screenshots/{page_index}:
    get:
      tags:
      - Page Screenshots
      summary: Get File Page Screenshot
      description: Get screenshot of a page from a file.
      operationId: get_file_page_screenshot_api_v1_files__id__page_screenshots__page_index__get
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Id
      - name: page_index
        in: path
        required: true
        schema:
          type: integer
          title: Page Index
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/files/{id}/page_screenshots/{page_index}/presigned_url:
    post:
      tags:
      - Page Screenshots
      summary: Generate File Page Screenshot Presigned Url
      description: Returns a short-lived presigned URL to read a page screenshot;
        treat the URL as sensitive while it is valid.
      operationId: generate_file_page_screenshot_presigned_url_api_v1_files__id__page_screenshots__page_index__presigned_url_post
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Id
      - name: page_index
        in: path
        required: true
        schema:
          type: integer
          title: Page Index
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresignedUrl'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/files/{id}/page-figures:
    get:
      tags:
      - Page Figures
      summary: List File Pages Figures
      description: List metadata for all figures from all pages of a file.
      operationId: list_file_pages_figures_api_v1_files__id__page_figures_get
      security:
      - HTTPBearer: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Id
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
      - name: organization_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Organization Id
      - name: session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PageFigureMetadata'
                title: Response List File Pages Figures Api V1 Files  Id  Page Figures
                  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/files/{id}/page-figures/{page_index}:
    get:
      tags:
      - Page Figures
      summary: List File Page Figures
      description: List metadata for figures from 

# --- truncated at 32 KB (804 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/llamaparse/refs/heads/main/openapi/llamaparse-llamacloud-openapi.yml