For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Article object
          • GET/articles
          • GET/articles/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsArticles

The Article object

The Article Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "title": "string",
7  "description": "string",
8  "author": "string",
9  "last_edited_by": "string",
10  "visibility": "PUBLIC",
11  "article_content_download_url": "string",
12  "checksum": "string",
13  "article_url": "string",
14  "status": "DRAFT",
15  "type": "PAGE",
16  "remote_created_at": "2023-01-01T00:00:00Z",
17  "remote_updated_at": "2023-01-01T00:00:00Z",
18  "parent_article": "string",
19  "parent_container": "string",
20  "root_container": "string",
21  "permissions": [
22    {
23      "id": "string",
24      "remote_id": "string",
25      "created_at": "2023-01-01T00:00:00Z",
26      "modified_at": "2023-01-01T00:00:00Z",
27      "user": "string",
28      "group": "string",
29      "type": "USER",
30      "roles": [
31        "READ"
32      ],
33      "remote_was_deleted": true,
34      "field_mappings": {}
35    }
36  ],
37  "attachments": [
38    "string"
39  ],
40  "remote_was_deleted": true,
41  "field_mappings": {},
42  "remote_data": [
43    {
44      "path": "string",
45      "data": {}
46    }
47  ]
48}
Was this page helpful?
Previous

Versioning

Next

/articles

Built with

The Article object is used to represent a form of content in the knowledge base, such as an article or page.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
titlestring or nullOptional<=254 characters
The title of the article.
descriptionstring or nullOptional<=2000 characters
Description of the article.
authorstring or nullOptionalformat: "uuid"
The user who created the article.
last_edited_bystring or nullOptionalformat: "uuid"
The user to last update the article.
visibilityenum or nullOptional
Allowed values:
article_content_download_urlstring or nullOptionalRead-only
The presigned S3 URL to fetch article content.
checksumstring or nullOptional<=254 characters
The SHA256 checksum of the article content.
article_urlstring or nullOptional<=2000 characters
The URL to the webpage of the article.
statusenum or nullOptional
Allowed values:
typeenum or nullOptional
Allowed values:
remote_created_atdatetime or nullOptional
When the third party's article was created.
remote_updated_atdatetime or nullOptional
When the third party's article was updated.
parent_articlestring or nullOptionalformat: "uuid"
The parent article an article is nested within.
parent_containerstring or nullOptionalformat: "uuid"
The parent container an article is nested within.
root_containerstring or nullOptionalformat: "uuid"
permissionslist of objectsOptional
attachmentslist of stringsOptional
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only