DocumentationTypeship CLITypeship MCPTypeship SDKsAPI Reference
Console
Spec revisions

List a Spec Revision's files

GET
/spec-revisions/{spec_revision_id}/files

Lists the captured source files and the resolved document Typeship generated from, ordered by path. Read content with getFile.

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

Path Parameters

spec_revision_id*string

Unique identifier for an immutable resolved Spec Revision.

Match^srev_[a-z0-9]{16}$

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/spec-revisions/srev_6m1q8v4k2p9d7h3c/files"
{  "object": "list",  "data": [    {      "id": "file_9d4k7m2q6v1p8h3c",      "object": "file",      "path": "/openapi.json",      "role": "entrypoint",      "size_bytes": 524,      "sha256": "3ccd2685803ba4c4db9bed78c3ef8d1993e119abbdafa1ab5dfa6d31846da05d",      "encoding": "utf8",      "mode": null,      "created_at": "2026-09-23T08:00:00Z"    },    {      "id": "file_1h6q3v9k2m7d4p8c",      "object": "file",      "path": "openapi.normalized.json",      "role": "resolved",      "size_bytes": 611,      "sha256": "8f434346648f6b96df89dda901c5176b10a6d83961dd3c1ac88b59b2dc327aa4",      "encoding": "utf8",      "mode": null,      "created_at": "2026-09-23T08:00:00Z"    }  ],  "has_more": false,  "next_cursor": null,  "request_id": "req_3k8m1v6q9p2d7h4c"}

Get a Spec Revision GET

Returns metadata for a saved Spec Revision with a Diagnostics summary. Pass `include=diagnostics` to add every Diagnostic, evaluated with the Spec's current patches and Diagnostic policy. List its source files and resolved document with listSpecRevisionFiles.

List Drafts GET

Lists open and merged Drafts, newest first. Each Target has one open Draft; each merge adds a merged Draft.