Get Documents | Fern Documentation

curl https://fai.buildwithfern.com/document/domain \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "documents": [
    {
      "document_id": "d3f9a7b2-8c4e-4f1a-9b2e-5a7c3d9e8f12",
      "domain": "example.com",
      "chunk": "Introduction to the product features and benefits.",
      "document": "This document provides an overview of the key features and benefits of our software product, including installation instructions and usage guidelines.",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "title": "Product Overview",
      "url": "https://example.com/docs/product-overview",
      "version": "1.2.0",
      "product": "Example Software Suite",
      "keywords": [
        "product",
        "overview",
        "features",
        "installation"
      ],
      "authed": false
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 10
  }
}

身份验证

AuthorizationBearer

Bearer 身份验证，格式为 Bearer <token>，其中 token 是您的身份验证令牌。

路径参数

domainstring必需

查询参数

pageinteger or null可选

The page number for pagination

limitinteger or null可选

The number of documents per page

响应

Successful Response

documentslist of objects

List of documents for the domain

paginationobject

Pagination information for the document list

错误

422

Unprocessable Entity Error

$	curl https://fai.buildwithfern.com/document/domain \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"documents": [
3	{
4	"document_id": "d3f9a7b2-8c4e-4f1a-9b2e-5a7c3d9e8f12",
5	"domain": "example.com",
6	"chunk": "Introduction to the product features and benefits.",
7	"document": "This document provides an overview of the key features and benefits of our software product, including installation instructions and usage guidelines.",
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"title": "Product Overview",
11	"url": "https://example.com/docs/product-overview",
12	"version": "1.2.0",
13	"product": "Example Software Suite",
14	"keywords": [
15	"product",
16	"overview",
17	"features",
18	"installation"
19	],
20	"authed": false
21	}
22	],
23	"pagination": {
24	"total": 1,
25	"page": 1,
26	"limit": 10
27	}
28	}