> ## 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. # Run Classify > Sort a document into one of the categories you list in `config.classifications`. Send a `file` or a `file_url`, with `config` or a saved `config_id`. By default, the call waits for the job to end. With `async: true`, it returns `202` at once. Read the result at `GET /classify/{classify_id}/result`. ## OpenAPI ````yaml /api-reference/v2/openapi.yml post /classify 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: post: tags: - Classify summary: Run Classify description: >- Sort a document into one of the categories you list in `config.classifications`. Send a `file` or a `file_url`, with `config` or a saved `config_id`. By default, the call waits for the job to end. With `async: true`, it returns `202` at once. Read the result at `GET /classify/{classify_id}/result`. operationId: classifyDocument 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: description: A document to classify, and the categories to choose from. title: ClassifyRequest oneOf: - title: Inline config additionalProperties: false type: object properties: file_url: description: >- The document's URL: a public `http(s)` URL, a public `s3://` or `gs://` object, or an upload URL Pulse issued. minLength: 1 title: File Url type: string config: $ref: '#/components/schemas/ClassifyConfig' description: This request's options. async: default: false description: >- Set to `true` to return `202` at once instead of waiting. title: Async type: boolean required: - file_url - config - title: Saved config additionalProperties: false type: object properties: async: default: false description: >- Set to `true` to return `202` at once instead of waiting. title: Async type: boolean file_url: description: >- The document's URL: a public `http(s)` URL, a public `s3://` or `gs://` object, or an upload URL Pulse issued. minLength: 1 title: File Url type: string config_id: description: A saved config's id, sent in place of `config`. title: Config Id type: string required: - file_url - config_id multipart/form-data: schema: oneOf: - title: Inline config type: object properties: file: type: string format: binary config: $ref: '#/components/schemas/ClassifyConfig' description: This request's options. async: default: false description: >- Set to `true` to return `202` at once instead of waiting. title: Async type: boolean required: - file - config - title: Saved config type: object properties: async: default: false description: >- Set to `true` to return `202` at once instead of waiting. title: Async type: boolean file: type: string format: binary config_id: description: A saved config's id, sent in place of `config`. title: Config Id type: string required: - file - config_id encoding: config: contentType: application/json async: contentType: application/json responses: '200': description: >- The classification completed. Read its result at `GET /classify/{classify_id}/result`. content: application/json: schema: $ref: '#/components/schemas/ClassifySyncResponse' '202': description: >- The classification started (`async: true`). Check `GET /classify/{classify_id}` until it ends. content: application/json: schema: $ref: '#/components/schemas/ClassifyAsyncResponse' '400': description: >- The request is invalid ([`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-invalid)): an unknown field, a value of the wrong type, or both or neither of `file` and `file_url` or of `config` and `config_id`. Also a `page_range` past the document's last page ([`PAGE_RANGE_INVALID`](https://docs.runpulse.com/errors/page-range-invalid)), or a `file_url` this install may not read ([`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: >- Your organization's billing blocks the request ([`PAYMENT_REQUIRED`](https://docs.runpulse.com/errors/payment-required), [`PLAN_LIMIT_REACHED`](https://docs.runpulse.com/errors/plan-limit-reached), [`CREDIT_LIMIT_EXCEEDED`](https://docs.runpulse.com/errors/credit-limit-exceeded), [`TRIAL_EXPIRED`](https://docs.runpulse.com/errors/trial-expired), [`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: - PAYMENT_REQUIRED - PLAN_LIMIT_REACHED - CREDIT_LIMIT_EXCEEDED - TRIAL_EXPIRED - PAYMENT_FAILED - PAYMENT_AUTHENTICATION_REQUIRED - SUBSCRIPTION_CANCELED - SUBSCRIPTION_PAST_DUE '403': description: >- Your account is suspended ([`ACCOUNT_SUSPENDED`](https://docs.runpulse.com/errors/account-suspended)), or an `s3://` or `gs://` `file_url` is outside your organization's files ([`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: >- `config_id` names no `/classify` config your organization saved ([`RESOURCE_NOT_FOUND`](https://docs.runpulse.com/errors/resource-not-found); `errors` names the field). 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: >- Without `async`, the classification was canceled (`DELETE /classify/{classify_id}`) before it ended ([`JOB_ALREADY_ENDED`](https://docs.runpulse.com/errors/job-already-ended)). 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_ALREADY_ENDED '413': description: >- The document is too large ([`FILE_TOO_LARGE`](https://docs.runpulse.com/errors/file-too-large)), or a multipart text part is over 10 MB ([`FIELD_TOO_LARGE`](https://docs.runpulse.com/errors/field-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: - FILE_TOO_LARGE - FIELD_TOO_LARGE '415': description: >- An unsupported file type ([`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 file can't be read ([`FILE_CORRUPT`](https://docs.runpulse.com/errors/file-corrupt)), has no pages ([`FILE_EMPTY`](https://docs.runpulse.com/errors/file-empty)), couldn't be downloaded ([`FILE_DOWNLOAD_FAILED`](https://docs.runpulse.com/errors/file-download-failed)), or is a PDF with active content that can't be removed ([`FILE_UNSAFE`](https://docs.runpulse.com/errors/file-unsafe)), or a workbook whose contents can't be read ([`DOCUMENT_UNPROCESSABLE`](https://docs.runpulse.com/errors/document-unprocessable)). 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 - FILE_EMPTY - FILE_DOWNLOAD_FAILED - FILE_UNSAFE - DOCUMENT_UNPROCESSABLE '500': description: >- The document couldn't be classified ([`PROCESSING_FAILED`](https://docs.runpulse.com/errors/processing-failed)); or an unexpected error ([`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: - PROCESSING_FAILED - SERVER_ERROR '503': description: >- A service the request needs is unavailable, an `async` job couldn't be started, or the job's final state couldn't be confirmed ([`SERVICE_UNAVAILABLE`](https://docs.runpulse.com/errors/service-unavailable)): when the problem carries `classify_id`, the result may be saved: poll `GET /classify/{classify_id}` instead of submitting the request again. Or Pulse is at capacity ([`CAPACITY_EXCEEDED`](https://docs.runpulse.com/errors/capacity-exceeded)); retry after the seconds in `Retry-After`. On a self-hosted install, its licence is invalid or expired ([`LICENSE_INVALID`](https://docs.runpulse.com/errors/license-invalid)) or not yet activated ([`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 - CAPACITY_EXCEEDED - LICENSE_INVALID - LICENSE_NOT_ACTIVATED '504': description: >- Downloading `file_url` timed out ([`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: ClassifyConfig: additionalProperties: false properties: page_range: pattern: ^ *[0-9]+ *(- *([0-9]+|end) *)?(, *[0-9]+ *(- *([0-9]+|end) *)?)*$ title: Page Range type: string classifications: items: $ref: '#/components/schemas/Classification' title: Classifications type: array required: - classifications title: ClassifyConfig { page_range, classifications } type: object ClassifySyncResponse: properties: classify_id: type: string title: Classify Id created_at: type: string title: Created At description: When the job was created. completed_at: type: string title: Completed At description: When the job ended. expires_at: type: string title: Expires At description: >- When the result will be deleted. Absent when the result is kept with no expiry. additionalProperties: false type: object required: - classify_id - created_at - completed_at title: ClassifySyncResponse description: >- A completed classification. Read its result at `GET /classify/{classify_id}/result`. ClassifyAsyncResponse: properties: classify_id: type: string title: Classify Id created_at: type: string title: Created At description: When the job was created. additionalProperties: false type: object required: - classify_id - created_at title: ClassifyAsyncResponse description: >- A classification that has started. Check `GET /classify/{classify_id}` until it ends. 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:`.' 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 Classification: additionalProperties: false properties: name: minLength: 1 title: Name type: string description: minLength: 1 title: Description type: string required: - name title: Classification { name, description } type: object 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.` / `header.`. 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: {} 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.