Documents

​
Rename a tab or move it to another position (the document itself stays first)

PATCH
/v1/space/documents/{document_id}/tabs/{tab_id}
curl -X PATCH "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E/tabs/%3Ctab_id%3E" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123" \  -H "Content-Type: application/json" \  -d '{  "name": "string",  "position": 1}'
{  "data": {    "document_id": "<string>",    "id": "<string>",    "name": "<string>",    "position": 0,    "updated_at": "2026-01-01T00:00:00Z"  }}

Get your Orchestor API key

Create an API key in your workspace settings.

Authorizations

Satisfy one of these options:

  • Session cookie
  • API key

Authentication details

cookie
wos-session

Browser session established by signing in to the web app. The server checks your workspace membership and permissions. Supply X-Workspace-ID for workspace-scoped operations. For server-to-server requests, use an API key when the operation supports it.

Path Parameters

document_idstringpathrequired
Pattern
^doc_[a-f0-9]{24}$
tab_idstringpathrequired
Pattern
^doc_[a-f0-9]{24}$

Headers

X-Workspace-IDstringheader

Workspace to access. With a workspace-scoped API key, the server derives this value from the key, so the header is optional. If supplied, it must match the credential workspace or the request returns 403 workspace_mismatch. For interactive session requests, supply this header to select a workspace where you are a member. A project ID cannot be used as a workspace ID.

Example"wks_abc123"

Bodyapplication/jsonrequired

Additional properties
Not allowed
namestringbody
String length
≥ 1, ≤ 255
positionintegerbody
Value range
≥ 0, ≤ 1000

Response

application/json

Updated tab

dataSpaceDocumentTabrequired
data.document_idstringrequired
data.idstringrequired
data.namestringrequired
data.positionintegerrequired
data.updated_atstringrequiredformat:date-time