Get Catalog file references for a home guide

GET /workspaces/{id}/agent-home-guide/guides/{guide_id}/files uses an ordinary product identity and has no request body. It first passes the regular service boundary, then calls the Catalog file list for the target volume subject to volume.read.

Request parameters

GET https://api.moi.matrixorigin.cn/v5/workspaces/{id}/agent-home-guide/guides/{guide_id}/files

Prepare an ordinary product identity for the current workspace, the target guide ID, and read permission on the relevant volumes. No business request body is required.

Guides and files

guide_id

Logical sample key

organize-documents

contract_saas_subscription、email_contract_approval

find-information

legal_constitution

automate-repetitive-work

email_shipment_exception、image_warehouse_receiving

analyze-data is not a file guide ID; the frontend uses the Catalog table metadata flow. File resolution reads only immutable samples for the deployment language and mounted workspace volumes, checking each file ID and volume ID. Missing initialization, mounts, or target files cause failure. It does not create or copy files, or substitute resources from another language.

Response fields

In the string code: "OK" envelope, data contains:

Field

Type

Description

guide_id

string

Current guide ID

language

string

Deployment-defined sample language

files

array

The following file objects, in guide-key order

files[].file_key

string

Stable logical sample key

files[].name

string

Trimmed Catalog name; falls back to the resolved filename when empty

files[].size

integer

Catalog file size in bytes

files[].type

string

Resolved content type; falls back to application/octet-stream when empty

files[].catalog_file.workspace_id

string

Current workspace

files[].catalog_file.volume_id

integer

Mounted volume ID

files[].catalog_file.file_id

string

Catalog file ID for subsequent attachment handoff

List queries fix page=1 and page_size=20 with a single file ID filter and the target volume. This is an internal existence check; the API exposes no pagination input.

Handler error mapping

HTTP

code

Condition

404

ErrObjectNotFound

Unknown guide ID

404

ErrSampleAssetMissing

Required sample unavailable

403

ErrForbidden

Authorization denied

503

ErrServiceUnavailable

Authorization service unavailable

500

ErrServer

Other error or error-message localization failure

The error envelope contains code, localized msg, and data: null. HTTP and envelope mappings are source evidence, not proof of a tested real request. Success only establishes that the file references were visible at read time. Subsequent task execution and model access still require verification.

Last updated on