Skip to content

Documents XML

Endpoints serving project-scoped documents as XML

Operations

List documents for a project as XML

Request

Fetches the list of documents from Studio scoped to projectId, then applies the transformation rule tagged {projectId}-list to produce XML. If the rule has addBinaryFile enabled, binary attachments are inlined as base64.

Security
OAuth2(Required scopes: documents.read)
Query
projectIdstringrequired

Project identifier. Also selects the XSLT transformation rule applied to the Studio response ({projectId} for single documents, {projectId}-list for lists).

stateArray of strings

Filter by one or more document states (forwarded to Studio).

limitinteger, (int32), >= 1

Maximum number of documents to return.

offsetinteger, (int32), >= 0

Number of documents to skip.

sortArray of strings

Sort expressions forwarded to Studio (e.g. createdAt,desc).

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/document-xml/documents?projectId=string&state=string&limit=1&offset=0&sort=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Transformed XML document list.

Bodyapplication/xml
string, (xml)(DocumentsXml)

XML document produced by applying the project-specific list transformation (XSLT) to the Studio response. The concrete element structure is defined per project.

Response
<root>&lt;documents&gt;
  &lt;document id=&quot;...&quot;/&gt;
&lt;/documents&gt;
</root>