get install readme rendered with

GET

/v1/installs/{install_id}/readme

Returns the app.readme markdown with the values interpolated from the install inputs and component outputs.

Authorizations

• APIKey
• OrgID

Parameters

Path Parameters

install_id

required

string

Install ID

Responses

200

OK

object

readme

string

400

Bad Request

object

description

string

error

string

user_error

boolean

401

Unauthorized

object

description

string

error

string

user_error

boolean

403

Forbidden

object

description

string

error

string

user_error

boolean

404

Not Found

object

description

string

error

string

user_error

boolean

500

Internal Server Error

object

description

string

error

string

user_error

boolean