ExPast API · ExBook

OpenAPI 3.1.0

ExBook API

API for spaces, pages, publication and search.

Версия 1.0.0https://0.0.0.0:3000/api

GET/health

getHealth

curl --request GET \
  --url "https://0.0.0.0:3000/api/health" \
  --header 'Accept: application/json'

Параметры

Параметры не требуются

Ответы

200

Service is healthy

GET/search

search

curl --request GET \
  --url "https://0.0.0.0:3000/api/search" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN'

Параметры

qqueryобязательный

Ответы

POST/spaces

createSpace

curl --request POST \
  --url "https://0.0.0.0:3000/api/spaces" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN'

Параметры

Параметры не требуются

Ответы

201

Space created

403

Insufficient role

GET/v1/pages

List pages in a space

curl --request GET \
  --url "https://0.0.0.0:3000/api/v1/pages" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN'

Параметры

spaceIdqueryобязательный

limitquery

Ответы

200

Pages

401

Invalid token or pages:read scope

POST/v1/pages

Create a page

curl --request POST \
  --url "https://0.0.0.0:3000/api/v1/pages" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"example":"value"}'

Параметры

Параметры не требуются

Тело запроса

application/json

{
  "type": "object",
  "required": [
    "spaceId",
    "title",
    "slug"
  ],
  "properties": {
    "slug": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "content": {
      "type": "object"
    },
    "spaceId": {
      "type": "string"
    },
    "parentId": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

Ответы

201

Page created

401

Invalid token or pages:write scope

GET/v1/spaces

List organization spaces

curl --request GET \
  --url "https://0.0.0.0:3000/api/v1/spaces" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN'

Параметры

Параметры не требуются

Ответы

200

Spaces visible to the API token

401

Invalid token or spaces:read scope

GET/pages/{id}

getPage

curl --request GET \
  --url "https://0.0.0.0:3000/api/pages/{id}" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN'

Параметры

idpathобязательный

Ответы

200

Page with versions and comments

PATCH/pages/{id}

updatePage

curl --request PATCH \
  --url "https://0.0.0.0:3000/api/pages/{id}" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN'

Параметры

idpathобязательный

Ответы

200

Updated page

POST/v1/ai/query

Ask a question grounded in one documentation space

Requires an organization API token with the ai:query scope. The answer includes numbered citations and source URLs.

curl --request POST \
  --url "https://0.0.0.0:3000/api/v1/ai/query" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"example":"value"}'

Параметры

Параметры не требуются

Тело запроса

application/json

{
  "question": {
    "value": {
      "query": "Как подключить API?",
      "spaceId": "cm123example"
    }
  }
}

Ответы

200

Grounded answer, source links and token usage

application/json

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "answer": {
          "type": "string"
        },
        "sources": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "format": "uri"
              },
              "index": {
                "type": "integer"
              },
              "title": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

401

Invalid token or missing ai:query scope

402

Monthly AI limit exceeded

409

AI profile is not configured

PATCH/v1/pages/{id}

Update or publish a page

curl --request PATCH \
  --url "https://0.0.0.0:3000/api/v1/pages/{id}" \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN'

Параметры

idpathобязательный

Ответы

200

Page updated

401

Invalid token or pages:write scope