StudioHomepage
ServicesCatalogHTTP APIState

Read a resource at a commit

GET
/api/catalog/projects/{project_id}/commits/{commit_id}/resources/{resource_id}

Read the identity and version of a resource at one immutable commit. When the commit does not exist, the response is CommitNotFound. When the resource is not live at the commit, the response is ResourceNotFound. You must have permission to read the project state.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Path Parameters

project_id*string

Owning project identifier. Nonempty, at most 128 UTF-8 bytes, with no control characters. Project creation belongs to the project service.

commit_id*string

Immutable UUIDv7 project commit identity.

Formatuuid
resource_id*string

Stable UUIDv4 identity allocated by a resource service.

Formatuuid

Response Body

Success

application/json
  1. response
descriptor*

Immutable registration metadata. namespaceRoot, when present, is an owning resource root containing every binding. namespaceManaged declares producer-owned canonical bindings that cannot be renamed, removed, or aliased. False must be supplied explicitly.

versionId*catalog.VersionId

Immutable UUIDv7 resource version allocated by its owning service.

Formatuuid
curl -X GET 'https://api.spiraldb.dev/api/catalog/projects/string/commits/497f6eca-6276-4993-bfeb-53cbbbba6f08/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "descriptor": {    "kind": "string",    "namespaceManaged": true,    "namespaceRoot": "cfa7f0de-65e7-43ae-ae5e-e42145401b8a",    "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",    "service": "string"  },  "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7"}