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

# Get a scraper run

> The status of one scraper run — the call to poll after `POST /api/scrape/{scraperId}`.

`result` holds the inline copy of the extracted data once the run completes. Large results keep only a preview inline, so read the full data from `GET /api/{scraperId}/data/{runId}`.

Requires the `read` permission.



## OpenAPI

````yaml GET /api/runs/{runId}
openapi: 3.1.0
info:
  title: ManyPI API
  description: >-
    The REST API behind ManyPI — AI lead generation, email validation,
    cold-email outreach, agent runs and web scraping. Every endpoint is
    authenticated with a ManyPI API key (`mpi_...`) or an OAuth 2.1 access
    token, and honours the permissions granted to that credential.
  version: 2.0.0
  contact:
    name: ManyPI Support
    email: support@manypi.com
    url: https://manypi.com
servers:
  - url: https://app.manypi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Leads
    description: Find, store, enrich and manage leads.
  - name: Email validation
    description: Verify that lead addresses can receive mail.
  - name: Outreach
    description: Inboxes, sequences, campaigns, sending and replies.
  - name: Agent
    description: Agent runs, replies and skills.
  - name: Scraping
    description: Scrapers, runs and extracted data.
  - name: Endpoints
    description: Publish scrapers as typed REST endpoints.
  - name: Account
    description: Key validation and account information.
paths:
  /api/runs/{runId}:
    get:
      tags:
        - Scraping
      summary: Get a scraper run
      description: >-
        The status of one scraper run — the call to poll after `POST
        /api/scrape/{scraperId}`.


        `result` holds the inline copy of the extracted data once the run
        completes. Large results keep only a preview inline, so read the full
        data from `GET /api/{scraperId}/data/{runId}`.


        Requires the `read` permission.
      operationId: getScraperRun
      parameters:
        - name: runId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The run.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      runId:
                        type: string
                        format: uuid
                      scraperId:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                          - pending
                          - running
                          - completed
                          - failed
                          - cancelled
                      metadata:
                        type: object
                        properties:
                          tokensConsumed:
                            type: integer
                            nullable: true
                          creditsUsed:
                            type: number
                            nullable: true
                          storageSizeBytes:
                            type: integer
                            nullable: true
                          createdAt:
                            type: string
                            format: date-time
                          updatedAt:
                            type: string
                            format: date-time
                      result:
                        type: object
                        additionalProperties: true
                        description: >-
                          Present once `status` is `completed`. May be a preview
                          for large results.
                      downloadUrl:
                        type: string
                        description: Storage path of the full result, when one was written.
                      error:
                        type: string
                        description: Present when `status` is `failed`.
              example:
                success: true
                data:
                  runId: b3c4d5e6-7f80-4912-a3b4-c5d6e7f8a901
                  scraperId: 9f1c2a44-0c3e-4b7a-8f61-2d5e8b9a1c33
                  status: completed
                  metadata:
                    tokensConsumed: 1240
                    creditsUsed: 3
                    storageSizeBytes: 8904
                    createdAt: '2026-08-08T08:53:30.710Z'
                    updatedAt: '2026-08-08T08:53:49.409Z'
                  result:
                    price: 49
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: The run belongs to another account.
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Unauthorized:
      description: >-
        Missing, invalid or expired credential — or a key that lacks the
        permission this route requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such resource in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          description: >-
            Human-readable message. A few validation failures (creating or
            updating an endpoint, bulk lead updates and deletes) send a list of
            the individual problems here instead of one string.
          oneOf:
            - type: string
            - type: array
              items:
                type: object
                properties:
                  path:
                    type: array
                    items:
                      type:
                        - string
                        - integer
                  message:
                    type: string
        code:
          type: string
          description: >-
            A machine-readable code on gated failures: `lead_limit`,
            `outreach_locked`, `validation_credits_exhausted`.
        details:
          description: >-
            Extra detail on some failures, such as the list of parameters that
            failed an endpoint's `param_schema`.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A ManyPI API key (`mpi_...`) from the profile menu → API Access in the
        dashboard, or an OAuth 2.1 access token obtained through the MCP consent
        flow.

````

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