---
title: "Queue document extraction"
method: POST
path: "/api/v1/project-rooms/{id}/files/{fileId}/read"
tags: ["Projects"]
---

# Queue document extraction

`POST /api/v1/project-rooms/{id}/files/{fileId}/read`

## Request

- Base URL: `https://askthegrid.com`
- URL: `https://askthegrid.com/api/v1/project-rooms/{id}/files/{fileId}/read`
- Auth: HTTP bearer

Editors queue extraction of a stored source. Set again to reread a current original; poll getProjectFile or getProjectJob for status.

## Path parameters

- `id` string, required
- `fileId` string, required

## Request body

- object
  - `again` boolean

## Response `200`

Success

- object
  - `job` object, required
    - `id` string, required
    - `kind` string, required
    - `key` string, required
    - `subjectId` string, nullable, required
    - `runId` string, nullable, required
    - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled', required
    - `progress` object, nullable, required
      - `done` number, required
      - `total` number, required
      - `note` string
      - `unit` string
      - `rate` number
      - `at` string
    - `attempts` integer, required
    - `maxAttempts` integer, required
    - `error` string, nullable, required
    - `createdBy` object, required
      - `email` string, required
      - `name` string
    - `createdAt` string, required
    - `startedAt` string, nullable, required
    - `finishedAt` string, nullable, required
    - `runAfter` string, required
    - `cancelRequested` boolean, required

## Other responses

- `400`: The request did not match the contract.
- `401`: Missing or invalid credentials.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds; `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` report the budget. Signed-in sessions and API keys have larger budgets than anonymous callers.

---

[API](https://skmtc.dev/askthegrid/apis/ask-the-grid-api.md) · [All operations](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/askthegrid/apis/ask-the-grid-api/revisions/9cd80115e395?raw)