GET
/
v1
/
indexes
/
{indexId}
/
documents
curl --location --request GET 'https://api.getmetal.io/v1/indexes/{indexId}/documents' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \

{
  "data": [
    {
      "id": "1",
      "text": "My text 1",
      "createdAt": "2023-07-03T14:27:02.413Z",
      "metadata": {}
    },
    {
      "id": "2",
      "text": "My text 2",
      "createdAt": "2023-07-03T14:27:02.418Z",
      "metadata": {}
    }
  ],
  "lastSeenObjectId": "64d529f3bd43b75ce5e020f9"
}

​
Auth Headers

x-metal-api-key
string
required

An API key for your org.

x-metal-client-id
string
required

A Client ID for your org.

​
Params

indexId
string
required

The Index ID

​
Query Params

limit
number

The number of documents to fetch. Defaults to 10.

page
number

The page number to fetch. Defaults to 1.

​
Response

data
Document Array
lastSeenObjectId
String

The last object id seen in the result set. This can be used for deep pagination.

Get DocumentDelete Document