Skip to main content
GET
/
documents
TypeScript SDK
import { Orchata } from '@orchata/sdk';

const client = new Orchata({ apiKey: 'oai_your_api_key' });

const { documents } = await client.documents.list({
  spaceId: 'space_123'
});
{
  "documents": [
    {
      "id": "<string>",
      "orgId": "<string>",
      "spaceId": "<string>",
      "filename": "<string>",
      "mimeType": "<string>",
      "fileSize": "<string>",
      "storageUrl": "<string>",
      "status": "<string>",
      "errorMessage": "<string>",
      "embeddingModel": "<string>",
      "metadata": "<string>",
      "createdAt": "2023-12-25",
      "updatedAt": "2023-12-25"
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123,
  "totalPages": 123
}

Authorizations

Oai-Api-Key
string
header
required

Query Parameters

page
number
default:1
Required range: x >= 1
pageSize
number
default:20
Required range: 1 <= x <= 100
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
spaceId
string
required

The ID of the space containing the documents

Example:

"space_123"

Response

Successfully retrieved documents

documents
object[]
required
total
number
required
page
number
required
pageSize
number
required
totalPages
number
required