Skip to main content
GET
/
orgs
/
{org_id}
/
projects
/
{project_id}
/
compose
/
plans
/
{plan_id}
cURL
curl --request GET \
  --url https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/compose/plans/{plan_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "modified_at": "2023-11-07T05:31:56Z",
  "size_bytes": 1,
  "content": "<string>",
  "preview": "<string>",
  "title": "<string>"
}

Authorizations

​
Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

​
org_id
string
required
​
project_id
string
required
​
plan_id
string
required

Plan id — the markdown filename without the .md extension.

Response

Plan details with content

A plan markdown file plus its full body.

​
id
string
required

Filename without the .md extension (e.g. create-a-new-section-logical-hennessy).

​
modified_at
string<date-time>
required
​
size_bytes
integer<int64>
required
Required range: x >= 0
​
content
string
required

Raw markdown body of the plan file.

​
preview
string | null

Short body preview (first non-empty paragraph after the title, trimmed).

​
title
string | null

Title parsed from the first # heading (with an optional Plan: prefix stripped).