Agent Docs

Read a collection using its share-link capability.

No bearer token is needed, but the unguessable share token is required. Use a link its owner chose to share. This handler uses the production Postgres backend. The local JSON fixture backend may not serve this route.

Inputs. Path, query and header fields are listed below. No request body is required.

Outputs. See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

Errors. API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

Rate limits. Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

Example setup. Use an identifier returned by the matching list, search or create operation. Sample identifiers are not a promise that a record exists.

get/api/collections/shared/{token}

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/collections/shared/{token}
  • Auth: none required

Path parameters

tokenstring required

24 hexadecimal characters from the authorized share link. Treat the link as a capability.

Response

Read a collection using its share-link capability.

schemaVersion'hugging-bay.shared-collection.v1' required
namestring required
descriptionstring required

Changes

No recorded changes to this operation across all 1 revision of this API.