Content

Download schema

Creates a new content record for the authenticated tenant from a Dimension Registry archetype payload.

POST

https://api.stackinternal.com

/v1/content

Creates a new content record for the authenticated tenant from a Dimension Registry archetype payload. › Request Body

Request body for creating a new content record from a Dimension Registry archetype payload.

InsertContentV3Request

source

string · required

The upstream system that produced the content, such as 'github' or 'slack'.

sourceId

string · required

The stable identifier from the upstream system for this content item. The combination of source and sourceId must be unique within the tenant.

sourceUri

string · uri · required

The absolute URI of the content item in the upstream system.

AccessControlListGrant[] · required

The access control entries that define who can view the content.

entityType

string · required

The source-specific entity type for this content item, such as 'markdown-file' or 'message'.

ArchetypeContentEnvelope · required

Standardized archetype envelope used for transport and storage.

Creates a new content record for the authenticated tenant from a Dimension Registry archetype payload. › Responses

Created

Response returned when a content version is created through the public v3 content endpoint.

InsertContentV3Response

contentId

string · uuid · required

The unique identifier of the stored content version that was created.

POST/v1/content

curl https://api.stackinternal.com/v1/content \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "source": "github",
  "sourceId": "repo:octo-org/octo-repo/markdown-file:docs/README.md",
  "sourceUri": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
  "acls": [
    {
      "kind": "group",
      "provider": "entra",
      "identifier": "engineering-all"
    }
  ],
  "entityType": "markdown-file",
  "data": {
    "representation": "archetype",
    "representationVersion": 1,
    "archetype": "document",
    "dataSchema": "com.stackoverflow.stackinternal.content.archetype.document.v1",
    "data": {
      "title": "README",
      "textContent": "# Hello\nThis is markdown.",
      "documentType": "markdown_file",
      "containerRef": "repo:octo-org/octo-repo",
      "sourceUrl": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
      "mimeType": "text/markdown",
      "sourceVersion": "blob-sha-1"
    }
  }
}'

Example Request Body

{
  "source": "github",
  "sourceId": "repo:octo-org/octo-repo/markdown-file:docs/README.md",
  "sourceUri": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
  "acls": [
    {
      "kind": "group",
      "provider": "entra",
      "identifier": "engineering-all"
    }
  ],
  "entityType": "markdown-file",
  "data": {
    "representation": "archetype",
    "representationVersion": 1,
    "archetype": "document",
    "dataSchema": "com.stackoverflow.stackinternal.content.archetype.document.v1",
    "data": {
      "title": "README",
      "textContent": "# Hello\nThis is markdown.",
      "documentType": "markdown_file",
      "containerRef": "repo:octo-org/octo-repo",
      "sourceUrl": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
      "mimeType": "text/markdown",
      "sourceVersion": "blob-sha-1"
    }
  }
}

json

Creates one content record for a markdown document with a group ACL.

Example Responses

{
  "contentId": "cccccccc-cccc-cccc-cccc-cccccccccccc"
}

json

Returns the identifier of the stored content version that was created.

application/json

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload.

PUT

https://api.stackinternal.com

/v1/content/{id}

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload. › path Parameters

id

string · uuid · required

The unique identifier for the stored content version to update.

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload. › Request Body

Request body for updating an existing content record from a Dimension Registry archetype payload.

UpdateContentV3Request

sourceUri

string · uri · required

The absolute URI of the content item in the upstream system.

AccessControlListGrant[] · required

The access control entries that define who can view the content.

entityType

string · required

The source-specific entity type for this content item, such as 'markdown-file' or 'message'.

ArchetypeContentEnvelope · required

Standardized archetype envelope used for transport and storage.

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload. › Responses

Response returned when a content version is created through the public v3 content endpoint.

InsertContentV3Response

contentId

string · uuid · required

The unique identifier of the stored content version that was created.

PUT/v1/content/{id}

curl https://api.stackinternal.com/v1/content/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "sourceUri": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
  "acls": [
    {
      "kind": "group",
      "provider": "entra",
      "identifier": "engineering-all"
    }
  ],
  "entityType": "markdown-file",
  "data": {
    "representation": "archetype",
    "representationVersion": 1,
    "archetype": "document",
    "dataSchema": "com.stackoverflow.stackinternal.content.archetype.document.v1",
    "data": {
      "title": "README",
      "textContent": "# Hello\nThis is updated markdown.",
      "documentType": "markdown_file",
      "containerRef": "repo:octo-org/octo-repo",
      "sourceUrl": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
      "mimeType": "text/markdown",
      "sourceVersion": "blob-sha-2"
    }
  }
}'

Example Request Body

{
  "sourceUri": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
  "acls": [
    {
      "kind": "group",
      "provider": "entra",
      "identifier": "engineering-all"
    }
  ],
  "entityType": "markdown-file",
  "data": {
    "representation": "archetype",
    "representationVersion": 1,
    "archetype": "document",
    "dataSchema": "com.stackoverflow.stackinternal.content.archetype.document.v1",
    "data": {
      "title": "README",
      "textContent": "# Hello\nThis is updated markdown.",
      "documentType": "markdown_file",
      "containerRef": "repo:octo-org/octo-repo",
      "sourceUrl": "https://github.com/octo-org/octo-repo/blob/main/docs/README.md",
      "mimeType": "text/markdown",
      "sourceVersion": "blob-sha-2"
    }
  }
}

json

Updates an existing content record when the latest stored fingerprint differs.

Example Responses

{
  "contentId": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}

json

Returns the identifier of the newly stored content version.

application/json

Deletes an existing content record for the authenticated tenant.

DELETE

https://api.stackinternal.com

/v1/content/{id}

Deletes an existing content record for the authenticated tenant. › path Parameters

id

string · uuid · required

The unique identifier for the stored content version to delete.

Deletes an existing content record for the authenticated tenant. › Responses

Returns when the content exists and is deleted.

No data returned

Knowledge

Creates a new content record for the authenticated tenant from a Dimension Registry archetype payload.

POST

https://api.stackinternal.com

/v1/content

Creates a new content record for the authenticated tenant from a Dimension Registry archetype payload. › Request Body

Request body for creating a new content record from a Dimension Registry archetype payload.

InsertContentV3Request

source

string · required

The upstream system that produced the content, such as 'github' or 'slack'.

sourceId

string · required

The stable identifier from the upstream system for this content item. The combination of source and sourceId must be unique within the tenant.

sourceUri

string · uri · required

The absolute URI of the content item in the upstream system.

AccessControlListGrant[] · required

The access control entries that define who can view the content.

entityType

string · required

The source-specific entity type for this content item, such as 'markdown-file' or 'message'.

ArchetypeContentEnvelope · required

Standardized archetype envelope used for transport and storage.

Creates a new content record for the authenticated tenant from a Dimension Registry archetype payload. › Responses

Created

Response returned when a content version is created through the public v3 content endpoint.

InsertContentV3Response

contentId

string · uuid · required

The unique identifier of the stored content version that was created.

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload.

PUT

https://api.stackinternal.com

/v1/content/{id}

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload. › path Parameters

id

string · uuid · required

The unique identifier for the stored content version to update.

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload. › Request Body

Request body for updating an existing content record from a Dimension Registry archetype payload.

UpdateContentV3Request

sourceUri

string · uri · required

The absolute URI of the content item in the upstream system.

AccessControlListGrant[] · required

The access control entries that define who can view the content.

entityType

string · required

The source-specific entity type for this content item, such as 'markdown-file' or 'message'.

ArchetypeContentEnvelope · required

Standardized archetype envelope used for transport and storage.

Updates an existing content record for the authenticated tenant from a Dimension Registry archetype payload. › Responses

Response returned when a content version is created through the public v3 content endpoint.

InsertContentV3Response

contentId

string · uuid · required

The unique identifier of the stored content version that was created.

Deletes an existing content record for the authenticated tenant.

DELETE

https://api.stackinternal.com

/v1/content/{id}

Deletes an existing content record for the authenticated tenant. › path Parameters

id

string · uuid · required

The unique identifier for the stored content version to delete.

Deletes an existing content record for the authenticated tenant. › Responses

Returns when the content exists and is deleted.

No data returned