Arkivel

Schema

This page is generated from the same OpenAPI document served at /api/v1/openapi.json. Contract metadata and SDK types are available at /api/v1/contract and /api/v1/sdk.

Server

http://localhost:3000

OpenAPI 3.1.0 · 10 operations

Operations

GET

`/api/v1/articles`

articlesapi-key

{ articles, pagination }

Parameters
Name	Location	Type	Requirement
`page`	query	integer	optional
`limit`	query	integer	optional
`category`	query	string	optional
`tag`	query	string	optional
`status`	query	string	optional
`workspaceId`	query	string	optional
`includeGlobal`	query	string	optional

Responses (5)

Responses for GET /api/v1/articles
Status	Description
`200`	{ articles, pagination }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/v1/categories`

categoriesapi-key

{ categories }

Responses (5)

Responses for GET /api/v1/categories
Status	Description
`200`	{ categories }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/v1/tags`

tagsapi-key

{ tags }

Responses (5)

Responses for GET /api/v1/tags
Status	Description
`200`	{ tags }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/v1/search`

searchapi-key

{ results, query }

Parameters
Name	Location	Type	Requirement
`q`	query	string	optional
`limit`	query	integer	optional
`workspaceId`	query	string	optional
`includeGlobal`	query	string	optional

Responses (5)

Responses for GET /api/v1/search
Status	Description
`200`	{ results, query }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/customization`

customizationpublic

{ customization, options, ui, marketplace }

Responses (5)

Responses for GET /api/customization
Status	Description
`200`	{ customization, options, ui, marketplace }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/plugins`

pluginsadmin-session

{ errors, loader, plugins }

Responses (5)

Responses for GET /api/plugins
Status	Description
`200`	{ errors, loader, plugins }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/webhooks`

webhooksadmin-session

[webhooks]

Responses (5)

Responses for GET /api/webhooks
Status	Description
`200`	[webhooks]
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/export/history`

exportsadmin-session

{ contract, history }

Responses (5)

Responses for GET /api/export/history
Status	Description
`200`	{ contract, history }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/articles/{id}/revisions/export`

revisionsadmin-session

text/csv revision export

Parameters
Name	Location	Type	Requirement
`id`	path	string	required

Responses (5)

Responses for GET /api/articles/{id}/revisions/export
Status	Description
`200`	text/csv revision export
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

GET

`/api/health`

healthpublic

{ status, uptime, dbConnected, version, articleCount, timestamp }

Responses (5)

Responses for GET /api/health
Status	Description
`200`	{ status, uptime, dbConnected, version, articleCount, timestamp }
`400`	Invalid query, body, pagination, sorting, or filter parameters.
`401`	Missing or invalid X-API-Key for API-key protected endpoints.
`403`	Authenticated actor lacks permission for the requested workspace or admin surface.
`429`	Rate limit exceeded; retry after the provided header delay.

Parameters

Name

Location

Type

Requirement

page

query

integer

optional

limit

query

integer

optional

category

query

string

optional

tag

query

string

optional

status

query

string

optional

workspaceId

query

string

optional

includeGlobal

query

string

optional

Status

Description

200

{ articles, pagination }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Status

Description

200

{ categories }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Status

Description

200

{ tags }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Parameters

Name

Location

Type

Requirement

q

query

string

optional

limit

query

integer

optional

workspaceId

query

string

optional

includeGlobal

query

string

optional

Status

Description

200

{ results, query }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Status

Description

200

{ customization, options, ui, marketplace }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Status

Description

200

{ errors, loader, plugins }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Status

Description

200

[webhooks]

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Status

Description

200

{ contract, history }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Parameters

Name

Location

Type

Requirement

id

path

string

required

Status

Description

200

text/csv revision export

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

Status

Description

200

{ status, uptime, dbConnected, version, articleCount, timestamp }

400

Invalid query, body, pagination, sorting, or filter parameters.

401

Missing or invalid X-API-Key for API-key protected endpoints.

403

Authenticated actor lacks permission for the requested workspace or admin surface.

429

Rate limit exceeded; retry after the provided header delay.

API reference

Schema

Operations

`/api/v1/articles`

`/api/v1/categories`

`/api/v1/tags`

`/api/v1/search`

`/api/customization`

`/api/plugins`

`/api/webhooks`

`/api/export/history`

`/api/articles/{id}/revisions/export`

`/api/health`

API reference

Schema

Operations

`/api/v1/articles`

`/api/v1/categories`

`/api/v1/tags`

`/api/v1/search`

`/api/customization`

`/api/plugins`

`/api/webhooks`

`/api/export/history`

`/api/articles/{id}/revisions/export`

`/api/health`