GET /documents

List documents

Agent-authored and manual documents. Requires `content:read`.

Authenticate with Authorization: Bearer obk_live_xxx. See authentication.

Parameters

Name	In	Type	Required	Description
`X-Workspace-Id`	header	string	required	The workspace to scope the request to. Can also be passed as a `workspace_id` query parameter.
`status`	query	string	optional
`limit`	query	integer	optional	Maximum number of items to return.

Responses

200 OK

Field	Type	Description
`workspace_id`	string
`documents`	Document[]

Example request

curl --request GET \
  --url https://app.orchly.ai/api/v1/documents \
  --header 'Authorization: Bearer obk_live_xxx' \
  --header 'X-Workspace-Id: ws_xxx'

const res = await fetch(`https://app.orchly.ai/api/v1/documents`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer obk_live_xxx',
    'X-Workspace-Id': 'ws_xxx',
  },
});
const data = await res.json();

import requests

resp = requests.get(
    "https://app.orchly.ai/api/v1/documents",
    headers={
        "Authorization": "Bearer obk_live_xxx",
        "X-Workspace-Id": "ws_xxx",
    },
)
data = resp.json()

Example response

A 200 response. Dynamic fields are shown as their type.

{
  "workspace_id": "string",
  "documents": [
    {
      "id": "string",
      "title": "string",
      "status": "string",
      "slug": "string",
      "meta_title": "string",
      "meta_description": "string",
      "word_count": 0,
      "task_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}