Skip to content

Documents ​

Documents, folders, versions and export. 16 endpoints

GET /documents​

/api/v1/documents · Needs a session

Parameters

FieldTypeRequiredNotes
q (query)string
folderId (query)string
botId (query)string

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents' \
  -H "Authorization: Bearer $LEX_TOKEN"

POST /documents​

/api/v1/documents · Needs a session

Request body

FieldTypeRequiredNotes
titlestringyeslength 1–200
folderIdstring | null
contentobject | object
markdownstringlength 0–500000

Example

bash
curl -X POST 'https://api.lexcetha.com/api/v1/documents' \
  -H "Authorization: Bearer $LEX_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"title":"string"}'

GET /documents/{documentId}​

/api/v1/documents/{documentId} · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents/:documentId' \
  -H "Authorization: Bearer $LEX_TOKEN"

PATCH /documents/{documentId}​

/api/v1/documents/{documentId} · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes

Request body

FieldTypeRequiredNotes
titlestringlength 1–200
contentobject | object
markdownstringlength 0–500000
folderIdstring | null
baseVersionintegeryesmax 9007199254740991
proposalobject
proposal.idstringyeslength 1–∞
proposal.outcome"accepted" | "partial"yes

Example

bash
curl -X PATCH 'https://api.lexcetha.com/api/v1/documents/:documentId' \
  -H "Authorization: Bearer $LEX_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"baseVersion":1}'

DELETE /documents/{documentId}​

/api/v1/documents/{documentId} · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes

Example

bash
curl -X DELETE 'https://api.lexcetha.com/api/v1/documents/:documentId' \
  -H "Authorization: Bearer $LEX_TOKEN"

/api/v1/documents/{documentId}/backlinks · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents/:documentId/backlinks' \
  -H "Authorization: Bearer $LEX_TOKEN"

GET /documents/{documentId}/agent-thread​

/api/v1/documents/{documentId}/agent-thread · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes
botId (query)string

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents/:documentId/agent-thread' \
  -H "Authorization: Bearer $LEX_TOKEN"

GET /documents/{documentId}/proposals​

/api/v1/documents/{documentId}/proposals · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes
status (query)string

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents/:documentId/proposals' \
  -H "Authorization: Bearer $LEX_TOKEN"

POST /document-proposals/{proposalId}/reject​

/api/v1/document-proposals/{proposalId}/reject · Needs a session

Parameters

FieldTypeRequiredNotes
proposalId (path)stringyes

Example

bash
curl -X POST 'https://api.lexcetha.com/api/v1/document-proposals/:proposalId/reject' \
  -H "Authorization: Bearer $LEX_TOKEN"

POST /documents/{documentId}/duplicate​

/api/v1/documents/{documentId}/duplicate · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes

Example

bash
curl -X POST 'https://api.lexcetha.com/api/v1/documents/:documentId/duplicate' \
  -H "Authorization: Bearer $LEX_TOKEN"

GET /documents/{documentId}/versions​

/api/v1/documents/{documentId}/versions · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents/:documentId/versions' \
  -H "Authorization: Bearer $LEX_TOKEN"

GET /documents/{documentId}/versions/{version}​

/api/v1/documents/{documentId}/versions/{version} · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes
version (path)stringyes

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents/:documentId/versions/:version' \
  -H "Authorization: Bearer $LEX_TOKEN"

POST /documents/{documentId}/versions/{version}/restore​

/api/v1/documents/{documentId}/versions/{version}/restore · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes
version (path)stringyes

Example

bash
curl -X POST 'https://api.lexcetha.com/api/v1/documents/:documentId/versions/:version/restore' \
  -H "Authorization: Bearer $LEX_TOKEN"

GET /documents/{documentId}/export​

/api/v1/documents/{documentId}/export · Needs a session

Parameters

FieldTypeRequiredNotes
documentId (path)stringyes

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/documents/:documentId/export' \
  -H "Authorization: Bearer $LEX_TOKEN"

GET /document-folders​

/api/v1/document-folders · Needs a session

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/document-folders' \
  -H "Authorization: Bearer $LEX_TOKEN"

POST /document-folders​

/api/v1/document-folders · Needs a session

Request body

FieldTypeRequiredNotes
namestringyeslength 1–100
parentIdstring | null

Example

bash
curl -X POST 'https://api.lexcetha.com/api/v1/document-folders' \
  -H "Authorization: Bearer $LEX_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"name":"string"}'

Lex by Gavalytics AI