Skip to main content
GET
App README
GET https://api-datahub.octoparse.com/v1/data-apps/{app_id}/readme Authentication: optional. With an API key you may see apps that require a logged-in view. Human-oriented rich text (raw Markdown). It is not part of the machine-readable detail payload and is fetched on demand. Defaults to the latest version.

Request

Path parameters

string
required
App reference: app_<hex> or <namespace>/<app_name>.

Query parameters

string
Version to read. Defaults to latest.

Example request

Response

200 success

The body is raw text/markdown with no envelope. Apps without a README return an empty body.

Errors

Error responses use {"error": {code, category, message, retryable}}. See Errors.

Client libraries

The Python and JavaScript SDKs do not wrap this endpoint yet. Call REST directly.