> ## 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 Pipeline Result > Get each step's current status. You can read it as soon as `POST /pipeline` returns, and after the pipeline ends or expires. It holds no step output, so read a completed step at its own endpoint, such as `GET /parse/{parse_id}/result`. `usage` totals the completed steps. Reading this doesn't count as reading a step's result. A step's result returns `410` once it has expired, or once it was read and your organization's retention deletes a result on its first read. ## OpenAPI ````yaml /api-reference/v2/openapi.yml get /pipeline/{pipeline_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: /pipeline/{pipeline_id}/result: get: tags: - Pipeline summary: Get Pipeline Result description: >- Get each step's current status. You can read it as soon as `POST /pipeline` returns, and after the pipeline ends or expires. It holds no step output, so read a completed step at its own endpoint, such as `GET /parse/{parse_id}/result`. `usage` totals the completed steps. Reading this doesn't count as reading a step's result. A step's result returns `410` once it has expired, or once it was read and your organization's retention deletes a result on its first read. operationId: getPipelineResult parameters: - name: pipeline_id in: path required: true schema: type: string description: The `pipeline_id` that `POST /pipeline` returned. title: Pipeline Id description: The `pipeline_id` that `POST /pipeline` returned. - name: Pulse-Version in: header required: false schema: type: string default: '2' title: Pulse-Version examples: default: value: '2' responses: '200': description: Each step's status, with what the completed steps used. content: application/json: schema: $ref: '#/components/schemas/PipelineResult' '400': description: >- An unknown query parameter was sent ([`REQUEST_INVALID`](https://docs.runpulse.com/errors/request-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 - UNSUPPORTED_VERSION '401': description: >- No valid API key was sent ([`CREDENTIALS_INVALID`](https://docs.runpulse.com/errors/credentials-invalid)), or the key is inactive ([`API_KEY_INACTIVE`](https://docs.runpulse.com/errors/api-key-inactive)). 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 '403': description: >- The account is suspended ([`ACCOUNT_SUSPENDED`](https://docs.runpulse.com/errors/account-suspended)). 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 '404': description: >- No pipeline with this id in your organization ([`RESOURCE_NOT_FOUND`](https://docs.runpulse.com/errors/resource-not-found)), including an id that is not a pipeline's, or a pipeline refused before any step was planned. 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 '500': description: >- [`JOB_UNREADABLE`](https://docs.runpulse.com/errors/job-unreadable): Pulse can't read this job right now; don't retry, contact support. 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: - JOB_UNREADABLE - SERVER_ERROR '503': description: >- The pipeline or one of its steps couldn't be read right now ([`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 security: - ApiKey: [] components: schemas: PipelineResult: properties: pipeline_id: type: string title: Pipeline Id description: The pipeline's id, `pipeline-`. step: $ref: '#/components/schemas/ParseStepStatus' description: The parse, with its status as `GET /parse/{parse_id}` returns it. children: items: oneOf: - $ref: '#/components/schemas/ExtractStepStatus' - $ref: '#/components/schemas/SplitStepStatus' - $ref: '#/components/schemas/TablesStepStatus' - $ref: '#/components/schemas/ChartsStepStatus' discriminator: propertyName: type mapping: charts: '#/components/schemas/ChartsStepStatus' extract: '#/components/schemas/ExtractStepStatus' split: '#/components/schemas/SplitStepStatus' tables: '#/components/schemas/TablesStepStatus' type: array title: Children description: >- Each step that reads the parse, in the order you sent them. Absent when there are none. usage: $ref: '#/components/schemas/Usage' description: What the completed steps used. The pipeline itself adds no charge. 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 pipeline and its steps expire, counted from when the pipeline ended. Absent while it runs or when results are kept. Retention that deletes on first read can remove a step's output sooner. history: $ref: '#/components/schemas/ResultHistory' description: >- The pipeline's document. `file_name` is its name, or `document` when the name is unknown. additionalProperties: false type: object required: - pipeline_id - step - usage - history title: PipelineResult description: >- Each step of a pipeline with its current status. You can read it at any time. 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 ParseStepStatus: properties: type: type: string const: parse title: Type description: Always `parse`, for the pipeline's first step. parse_id: type: string title: Parse Id description: The parse's id, `parse-`. created_at: type: string title: Created At description: When the job was created. status: type: string enum: - queued - processing - completed - failed - canceled - expired title: Status description: >- The job has ended once it's `completed`, `failed`, `canceled` or `expired` (its result was deleted). completed_at: type: string title: Completed At description: When the job ended. Absent while it runs. expires_at: type: string title: Expires At description: >- When a completed job's result will be deleted. Absent when the result is kept with no expiry. error: $ref: '#/components/schemas/Problem' description: >- Why the job failed: the problem its own request would have answered. Present only when `failed`. additionalProperties: false type: object required: - type - parse_id - created_at - status title: ParseStepStatus description: The pipeline's parse, as `GET /parse/{parse_id}` returns it. ExtractStepStatus: properties: type: type: string const: extract title: Type description: Always `extract`, for an extraction step that reads the parse. extract_id: type: string title: Extract Id description: The extraction's id, `extract-`. created_at: type: string title: Created At description: When the job was created. status: type: string enum: - queued - processing - completed - failed - canceled - expired - skipped title: Status description: >- The job has ended once it's `completed`, `failed`, `canceled` or `expired` (its result was deleted). `skipped` means the step never ran because the parse didn't complete. Its own endpoint reports it as `canceled`. completed_at: type: string title: Completed At description: When the job ended. Absent while it runs. expires_at: type: string title: Expires At description: >- When a completed job's result will be deleted. Absent when the result is kept with no expiry. error: $ref: '#/components/schemas/Problem' description: >- Why the job failed: the problem its own request would have answered. Present only when `failed`. additionalProperties: false type: object required: - type - extract_id - created_at - status title: ExtractStepStatus description: |- An extraction step. Once it's `completed`, read its output at `GET /extract/{extract_id}/result`. SplitStepStatus: properties: type: type: string const: split title: Type description: Always `split`, for a split step that reads the parse. split_id: type: string title: Split Id description: The split's id, `split-`. created_at: type: string title: Created At description: When the job was created. status: type: string enum: - queued - processing - completed - failed - canceled - expired - skipped title: Status description: >- The job has ended once it's `completed`, `failed`, `canceled` or `expired` (its result was deleted). `skipped` means the step never ran because the parse didn't complete. Its own endpoint reports it as `canceled`. completed_at: type: string title: Completed At description: When the job ended. Absent while it runs. expires_at: type: string title: Expires At description: >- When a completed job's result will be deleted. Absent when the result is kept with no expiry. error: $ref: '#/components/schemas/Problem' description: >- Why the job failed: the problem its own request would have answered. Present only when `failed`. additionalProperties: false type: object required: - type - split_id - created_at - status title: SplitStepStatus description: >- A split step. Once it's `completed`, read its output at `GET /split/{split_id}/result`. TablesStepStatus: properties: type: type: string const: tables title: Type description: Always `tables`, for a tables step that reads the parse. tables_id: type: string title: Tables Id description: The tables job's id, `tables-`. created_at: type: string title: Created At description: When the job was created. status: type: string enum: - queued - processing - completed - failed - canceled - expired - skipped title: Status description: >- The job has ended once it's `completed`, `failed`, `canceled` or `expired` (its result was deleted). `skipped` means the step never ran because the parse didn't complete. Its own endpoint reports it as `canceled`. completed_at: type: string title: Completed At description: When the job ended. Absent while it runs. expires_at: type: string title: Expires At description: >- When a completed job's result will be deleted. Absent when the result is kept with no expiry. error: $ref: '#/components/schemas/Problem' description: >- Why the job failed: the problem its own request would have answered. Present only when `failed`. additionalProperties: false type: object required: - type - tables_id - created_at - status title: TablesStepStatus description: |- A tables step. Once it's `completed`, read its output at `GET /tables/{tables_id}/result`. ChartsStepStatus: properties: type: type: string const: charts title: Type description: Always `charts`, for a charts step that reads the parse. charts_id: type: string title: Charts Id description: The charts job's id, `charts-`. created_at: type: string title: Created At description: When the job was created. status: type: string enum: - queued - processing - completed - failed - canceled - expired - skipped title: Status description: >- The job has ended once it's `completed`, `failed`, `canceled` or `expired` (its result was deleted). `skipped` means the step never ran because the parse didn't complete. Its own endpoint reports it as `canceled`. completed_at: type: string title: Completed At description: When the job ended. Absent while it runs. expires_at: type: string title: Expires At description: >- When a completed job's result will be deleted. Absent when the result is kept with no expiry. error: $ref: '#/components/schemas/Problem' description: >- Why the job failed: the problem its own request would have answered. Present only when `failed`. additionalProperties: false type: object required: - type - charts_id - created_at - status title: ChartsStepStatus description: |- A charts step. Once it's `completed`, read its output at `GET /charts/{charts_id}/result`. 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.` / `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: {} 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.