Plans

This plan’s own instructions

GET
/v1/projects/{projectSlug}/plans/{planShortId}/instructions

Authorization

bearerAuth
AuthorizationBearer <token>

A personal API key (psk_…) or an OAuth access token (plan_at_…). Scopes: read, write.

In: header

Path Parameters

projectSlug*string

Project slug, e.g. recipe-box.

planShortId*string

Plan handle within the project, e.g. PLAN-12.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/projects/string/plans/string/instructions"
{  "instructions": {    "scope": "company",    "markdown": "string",    "path": "string",    "bytes": 0,    "maxBytes": 0,    "characters": 0,    "maxInjectedCharacters": 0,    "proposalPending": true  }}