Workflow-run
Task
Document
- GETDocument metadata
- GETFull document details
- GETDocument CSV content
- POSTUnzip file and return PDFs
- POSTGenerate CSV document
- POSTPresigned URL for upload
- POSTClassify document (async)
- POSTSplit document (async)
- POSTCreate documents from splits
- POSTLegacy extract document (async)
- POSTDocument extraction (async)
- POSTRender document body
- POSTGenerate document from template (async)
- POSTTransform JSON to HTML
- POSTDocument reasoning (async)
- POSTSearch across documents
Async-result
Communication
Clearinghouse
Ledger
Integration - Snowflake
Document
Document metadata
Retrieves metadata for a specific document, including a presigned URL for direct access if applicable.
GET
/
api
/
v2
/
documents
/
{documentId}
/
metadata
Copy
import os
from samplehc import SampleHealthcare
client = SampleHealthcare(
api_key=os.environ.get("SAMPLEHC_API_KEY"), # This is the default and can be omitted
)
response = client.v2.documents.retrieve_metadata(
"documentId",
)
print(response.id)
Copy
{
"id": "<string>",
"fileName": "<string>",
"presignedUrl": "<string>"
}
Path Parameters
The unique identifier of the document.
Response
200
application/json
Successfully retrieved document metadata.
Copy
import os
from samplehc import SampleHealthcare
client = SampleHealthcare(
api_key=os.environ.get("SAMPLEHC_API_KEY"), # This is the default and can be omitted
)
response = client.v2.documents.retrieve_metadata(
"documentId",
)
print(response.id)
Copy
{
"id": "<string>",
"fileName": "<string>",
"presignedUrl": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.