Get a Spec Revision
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. Add filter=blocking to receive only the locations that fail the policy, which is what to fix when diagnostic_summary.status is blocked. List its source files and resolved document with listSpecRevisionFiles.
Authorization
apiKey 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
Unique identifier for an immutable resolved Spec Revision.
^srev_[a-z0-9]{16}$Query Parameters
Add related data to the response. diagnostics adds the diagnostics and patch_diagnostics arrays.
Value in
- "diagnostics"
Narrow the included Diagnostics to matching locations. Requires include=diagnostics. blocking: locations that fail the Diagnostic policy. introduced: locations new since the baseline. A Diagnostic with no matching location is omitted. diagnostic_summary always describes the complete revision.
Value in
- "blocking"
- "introduced"
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"{ "id": "srev_6m1q8v4k2p9d7h3c", "object": "spec_revision", "project_id": "prj_4f8k2m7x9q1v6b3n", "spec_id": "spec_2p8m4q7k1v9d6h3c", "format": "openapi", "file_count": 1, "sha256": "3ccd2685803ba4c4db9bed78c3ef8d1993e119abbdafa1ab5dfa6d31846da05d", "size_bytes": 524, "source": { "type": "url", "url": { "url": "https://api.parcel.example/openapi.json" } }, "diagnostic_summary": { "status": "passed", "error_count": 0, "warning_count": 0, "suggestion_count": 1, "blocking_count": 0, "baseline_spec_revision_id": null }, "created_at": "2026-09-23T08:00:00Z", "request_id": "req_3k8m1v6q9p2d7h4c"}List Spec Revisions GET
Lists Spec Revisions, newest first. Source content is not included; list a revision's files with listSpecRevisionFiles.
List a Spec Revision's files GET
Lists the captured source files and the resolved document Typeship generated from, ordered by path. Read content with getFile.