> ## 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.

# Get Classify Result

> Get a completed classification's category and confidence, with the credits it used.



## OpenAPI

````yaml /api-reference/v2/openapi.yml get /classify/{classify_id}/result
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:
  /classify/{classify_id}/result:
    get:
      tags:
        - Classify
      summary: Get Classify Result
      description: >-
        Get a completed classification's category and confidence, with the
        credits it used.
      operationId: getClassifyResult
      parameters:
        - name: classify_id
          in: path
          required: true
          schema:
            type: string
            description: The `classify_id` that `POST /classify` returned.
            title: Classify Id
          description: The `classify_id` that `POST /classify` returned.
        - name: Pulse-Version
          in: header
          required: false
          schema:
            type: string
            default: '2'
            title: Pulse-Version
          examples:
            default:
              value: '2'
      responses:
        '200':
          description: The classification's result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassifyResult'
        '400':
          description: >-
            [`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-invalid):
            a query parameter this route doesn't take. The classification
            failed, and this is its error
            ([`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-invalid),
            [`PAGE_RANGE_INVALID`](https://docs.runpulse.com/errors/page-range-invalid),
            [`FILE_URL_INVALID`](https://docs.runpulse.com/errors/file-url-invalid)).
            `Pulse-Version` names a version this API doesn't serve
            ([`UNSUPPORTED_VERSION`](https://docs.runpulse.com/errors/unsupported-version)).
          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:
            - REQUEST_INVALID
            - PAGE_RANGE_INVALID
            - FILE_URL_INVALID
            - UNSUPPORTED_VERSION
        '401':
          description: >-
            [`CREDENTIALS_INVALID`](https://docs.runpulse.com/errors/credentials-invalid):
            the API key is missing or not valid.
            [`API_KEY_INACTIVE`](https://docs.runpulse.com/errors/api-key-inactive):
            the API key is inactive; create a new one.
          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:
            - CREDENTIALS_INVALID
            - API_KEY_INACTIVE
        '402':
          description: >-
            The classification failed, and this is its error
            ([`TRIAL_EXPIRED`](https://docs.runpulse.com/errors/trial-expired),
            [`CREDIT_LIMIT_EXCEEDED`](https://docs.runpulse.com/errors/credit-limit-exceeded),
            [`PAYMENT_REQUIRED`](https://docs.runpulse.com/errors/payment-required),
            [`PLAN_LIMIT_REACHED`](https://docs.runpulse.com/errors/plan-limit-reached),
            [`PAYMENT_FAILED`](https://docs.runpulse.com/errors/payment-failed),
            [`PAYMENT_AUTHENTICATION_REQUIRED`](https://docs.runpulse.com/errors/payment-authentication-required),
            [`SUBSCRIPTION_CANCELED`](https://docs.runpulse.com/errors/subscription-canceled),
            [`SUBSCRIPTION_PAST_DUE`](https://docs.runpulse.com/errors/subscription-past-due)).
          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:
            - TRIAL_EXPIRED
            - CREDIT_LIMIT_EXCEEDED
            - PAYMENT_REQUIRED
            - PLAN_LIMIT_REACHED
            - PAYMENT_FAILED
            - PAYMENT_AUTHENTICATION_REQUIRED
            - SUBSCRIPTION_CANCELED
            - SUBSCRIPTION_PAST_DUE
        '403':
          description: >-
            [`ACCOUNT_SUSPENDED`](https://docs.runpulse.com/errors/account-suspended):
            your account is suspended. The classification failed, and this is
            its error
            ([`PERMISSION_DENIED`](https://docs.runpulse.com/errors/permission-denied)).
          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:
            - ACCOUNT_SUSPENDED
            - PERMISSION_DENIED
        '404':
          description: >-
            [`RESOURCE_NOT_FOUND`](https://docs.runpulse.com/errors/resource-not-found):
            your organization has no classification with this id, or it isn't a
            `classify-` id. The classification failed, and this is its error
            ([`RESOURCE_NOT_FOUND`](https://docs.runpulse.com/errors/resource-not-found)).
            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:
            - RESOURCE_NOT_FOUND
            - ROUTE_NOT_FOUND
        '409':
          description: >-
            [`JOB_NOT_FINISHED`](https://docs.runpulse.com/errors/job-not-finished):
            the classification is still `queued` or `processing`; poll `GET
            /classify/{classify_id}` until it is `completed`.
          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:
            - JOB_NOT_FINISHED
        '410':
          description: >-
            [`RESULT_EXPIRED`](https://docs.runpulse.com/errors/result-expired):
            the result expired under your retention.
            [`JOB_CANCELED`](https://docs.runpulse.com/errors/job-canceled): the
            job was canceled.
            [`RESULT_ALREADY_FETCHED`](https://docs.runpulse.com/errors/result-already-fetched):
            your organization's retention deletes a result on its first read,
            and this one was read.
          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:
            - RESULT_EXPIRED
            - JOB_CANCELED
            - RESULT_ALREADY_FETCHED
        '413':
          description: >-
            The classification failed, and this is its error
            ([`FIELD_TOO_LARGE`](https://docs.runpulse.com/errors/field-too-large),
            [`FILE_TOO_LARGE`](https://docs.runpulse.com/errors/file-too-large)).
          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:
            - FIELD_TOO_LARGE
            - FILE_TOO_LARGE
        '415':
          description: >-
            The classification failed, and this is its error
            ([`FILE_TYPE_UNSUPPORTED`](https://docs.runpulse.com/errors/file-type-unsupported)).
          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:
            - FILE_TYPE_UNSUPPORTED
        '422':
          description: >-
            The classification failed, and this is its error
            ([`FILE_CORRUPT`](https://docs.runpulse.com/errors/file-corrupt),
            [`DOCUMENT_UNPROCESSABLE`](https://docs.runpulse.com/errors/document-unprocessable),
            [`FILE_EMPTY`](https://docs.runpulse.com/errors/file-empty),
            [`FILE_DOWNLOAD_FAILED`](https://docs.runpulse.com/errors/file-download-failed),
            [`FILE_UNSAFE`](https://docs.runpulse.com/errors/file-unsafe)).
          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:
            - FILE_CORRUPT
            - DOCUMENT_UNPROCESSABLE
            - FILE_EMPTY
            - FILE_DOWNLOAD_FAILED
            - FILE_UNSAFE
        '500':
          description: >-
            [`SERVER_ERROR`](https://docs.runpulse.com/errors/server-error): an
            unexpected error.
            [`JOB_UNREADABLE`](https://docs.runpulse.com/errors/job-unreadable):
            Pulse can't read this job right now; don't retry, contact support.
            The classification failed, and this is its error
            ([`PROCESSING_FAILED`](https://docs.runpulse.com/errors/processing-failed),
            [`SERVER_ERROR`](https://docs.runpulse.com/errors/server-error)).
          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
            - JOB_UNREADABLE
            - PROCESSING_FAILED
        '503':
          description: >-
            [`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable):
            the classification or its result couldn't be read; retry. A
            classification that failed with
            [`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable)
            answers it on every read: run it again. The classification failed,
            and this is its error
            ([`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable)).
            On a self-hosted install that hasn't been activated yet,
            [`LICENSE_NOT_ACTIVATED`](https://docs.runpulse.com/errors/license-not-activated).
          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
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: string
          x-pulse-errors:
            - SERVICE_UNAVAILABLE
            - LICENSE_NOT_ACTIVATED
        '504':
          description: >-
            The classification failed, and this is its error
            ([`FILE_DOWNLOAD_TIMEOUT`](https://docs.runpulse.com/errors/file-download-timeout)).
          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:
            - FILE_DOWNLOAD_TIMEOUT
      security:
        - ApiKey: []
components:
  schemas:
    ClassifyResult:
      properties:
        classification:
          type: string
          title: Classification
        classify_id:
          type: string
          title: Classify Id
        confidence:
          anyOf:
            - type: number
            - type: 'null'
          title: Confidence
        usage:
          $ref: '#/components/schemas/Usage'
          description: The pages and credits this request used.
        warnings:
          items:
            $ref: '#/components/schemas/Warning'
          type: array
          title: Warnings
          description: Issues that may affect this result. Absent when there are none.
        expires_at:
          type: string
          title: Expires At
          description: >-
            When the result will be deleted. Absent when the result is kept with
            no expiry.
        history:
          $ref: '#/components/schemas/ResultHistory'
      additionalProperties: false
      type: object
      required:
        - classification
        - classify_id
        - confidence
        - usage
        - history
      title: ClassifyResult
      description: A completed classification's result.
    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
    Usage:
      properties:
        request:
          $ref: '#/components/schemas/UsageRequest'
        org:
          $ref: '#/components/schemas/OrganizationUsage'
          description: >-
            Your organization's usage, including this request. Absent when it
            couldn't be read.
      additionalProperties: false
      type: object
      required:
        - request
      title: Usage
      description: Pages and credits used, by this request and by your organization.
    Warning:
      properties:
        code:
          type: string
          title: Code
          description: A stable code naming the warning. Match on this, not `message`.
        message:
          type: string
          title: Message
          description: A human-readable explanation. Its wording may change.
      additionalProperties: false
      type: object
      required:
        - code
        - message
      title: Warning
      description: Something that didn't stop the job but may affect its result.
    ResultHistory:
      properties:
        file_name:
          type: string
          title: File Name
          description: The original document's name.
        previous_step:
          type: string
          title: Previous Step
          description: >-
            The id of the result this one was built from, a `parse_id` or a
            `split_id`. Absent on `/parse` results.
      additionalProperties: false
      type: object
      required:
        - file_name
      title: ResultHistory
      description: Where this result came from.
    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
    JsonValue: {}
    UsageRequest:
      properties:
        pages_processed:
          type: integer
          title: Pages Processed
          description: Pages this request processed.
        credits_used:
          type: number
          title: Credits Used
          description: Credits this request used.
      additionalProperties: false
      type: object
      required:
        - pages_processed
        - credits_used
      title: UsageRequest
      description: What this request used.
    OrganizationUsage:
      properties:
        pages_processed:
          type: integer
          title: Pages Processed
          description: >-
            Pages processed, including this request's. A document's pages count
            once, when it is parsed: a step that reads a parse adds none.
        credits_used:
          type: number
          title: Credits Used
          description: Credits used, including this request's.
        credit_allowance:
          type: number
          title: Credit Allowance
          description: >-
            The credits your plan includes per billing period, or in total if it
            has no billing period. Absent on pay-as-you-go plans.
      additionalProperties: false
      type: object
      required:
        - pages_processed
        - credits_used
      title: OrganizationUsage
      description: >-
        Your organization's usage in its current billing period, including this
        request. If your

        plan has no billing period, it covers all time.
  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.