Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

AiQL-Workspace
string
required

ID of the workspace the request operates on.

Path Parameters

id
string
required

Body

application/json
type
enum<string>
required

Type of change being proposed.

Available options:
SOURCE_ADD,
SOURCE_REMOVE
source_id
string
required

ID of the source (document) this change targets.

description
string | null

Description of the change.

Response

Successful Response

id
string
required

Unique identifier of the change.

type
string
required

Type of change.

description
string | null
required

Description of the change.

created_at
string<date-time>
required

Timestamp when the change was created.

updated_at
string<date-time>
required

Timestamp when the change was last updated.

source
SourceRef · object | null

Source targeted by this change.