DocumentationTypeship CLITypeship MCPTypeship SDKsAPI Reference
Console
Generations

List generations

GET
/generations

Authorization

apiKey
AuthorizationBearer <token>

Organization API key from the console (ak_...), or an OAuth access token with user:org:read, the organization selected during consent, and the capability required by the operation.

In: header

Query Parameters

limit?integer

Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400 invalid_request. List query parameters must appear only once; unrecognized parameters also return 400.

Range1 <= value <= 100
Default20
cursor?string

Opaque cursor from the preceding page's next_cursor. Valid only for the same organization, operation, filters, and ordering that issued it. Omit to start at the first page. Empty, malformed, or repeated cursors return 400 invalid_request. The page limit may change between requests.

Match^[A-Za-z0-9_-]+$
Length1 <= length <= 2048
project_id?string

Only Generations in this Project.

Match^prj_[a-z0-9]{16}$
target_id?string

Only Generations of this Target.

Match^tgt_[a-z0-9]{16}$
status?string

Only Generations with this status.

Value in

  • "queued"
  • "running"
  • "completed"
  • "failed"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/generations"
{  "object": "list",  "data": [    {      "id": "gen_7h2p5d9c3m8w1k6q",      "object": "generation",      "project_id": "prj_4f8k2m7x9q1v6b3n",      "spec_revision_id": "srev_6m1q8v4k2p9d7h3c",      "status": "completed",      "trigger": "manual",      "target_id": "tgt_5m8q2v7k1p9d4h6c",      "type": "cli",      "name": "parcel-cli",      "version": "1.0.0",      "warnings": [],      "coverage": {        "generated": 12,        "omitted": 0,        "total": 12,        "omitted_operations": []      },      "file_count": 1,      "errors": [],      "runtime_ms": 4200,      "created_at": "2026-09-23T08:00:00Z",      "updated_at": "2026-09-23T08:00:00Z"    }  ],  "has_more": false,  "next_cursor": null,  "request_id": "req_3k8m1v6q9p2d7h4c"}

Refresh a Spec from its configured source POST

Fetches the configured source now and creates a new Spec Revision only when its content changes. Diagnostics then reads that revision. If automatic generation is enabled, refresh queues generation for active Targets even when the source is unchanged.

Get a generation GET

Returns the status of that Generation. `queued` and `running` mean generation is still in progress. `completed` means generated files are saved, not that repository delivery or a Draft is complete. List its files with listGenerationFiles and read each with getFile.