---
title: "ingest_remote"
method: POST
path: "/v1/ingest/documents/remote"
tags: ["Documents"]
---

# ingest_remote

`POST /v1/ingest/documents/remote`

Ingest documents hosted on public URLs to a GroundX bucket. 

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

## Request body

- DocumentRemoteIngestRequest
  - `documents` object[], required
    - `bucketId` integer, required — the bucketId of the bucket which this remote file will be ingested to.
    - `fileName` string — The name of the file being ingested
    - `fileType` 'txt' | 'docx' | 'pptx' | 'xlsx' | 'pdf' | 'png' | 'jpg' | 'csv' | 'tsv' | 'json' — The type of document (one of the seven currently supported file types)
    - `searchData` object — Custom metadata which can be used to influence GroundX's search functionality. This data can be used to further hone GroundX search.
    - `sourceUrl` string, uri, required — The URL of the document being ingested by GroundX.

## Response `200`

Documents successfully uploaded

- IngestResponse
  - `ingest` object, required
    - `processId` string, uuid, required
    - `status` 'queued' | 'processing' | 'error' | 'complete' | 'cancelled', required

## Other responses

- `400` — Invalid document type or source URL
- `401` — Unauthorized to update bucket with given ID

---

[API](https://skmtc.net/groundxai/apis/groundx-apis.md) · [All operations](https://skmtc.net/groundxai/apis/groundx-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/groundxai/groundx-apis/versions/1c1a5c17f52f/schema)