Skip to content
Kindgi

Fetch a specific data block version

View as Markdown
GET
/v1/blocks/{blockId}/versions/{version}
curl --request GET \
  --url https://example.com/v1/blocks/example/versions/example \
  --header 'Authorization: Bearer <token>'

An unregistered version is returned too, with unregisteredAt.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
blockId
required
string
>= 1 characters

Block id: dotted lowercase (e.g. acme.intake-prompt).

version
required
string
>= 1 characters

Exact block version (major.minor.patch).

Responses

Section titled “Responses”

200

Section titled “200”

The block at that version.

Media typeapplication/json

A data block version: a prompt or settings, versioned like a tool (immutable versions, soft unregister). An agent version pins the block versions it uses when it is published. Belongs to one project and is authorized through it.

object
id
required

Dotted lowercase id (e.g. acme.intake-prompt).

string
version
required
string
/^\d+\.\d+\.\d+$/
kind
required

prompt: a Liquid template an agent renders as its instructions. settings: a JSON object tools and templates read.

string
Allowed values: prompt settings
description
string
content
required
One of:
object
template
required

Liquid, rendered as an agent’s instructions are (same parameters and auto-injected variables).

string
>= 1 characters
parameters
Array<object>
object
name
required
string
description
string
type
required
string
Allowed values: string number boolean date
required
boolean
default

Default value used when the caller omits this parameter.

projectId
required
string format: uuid
publishedAt
required
string format: date-time
unregisteredAt

Present only on an unregistered version; agent versions that pin it still read it. A retired block (every version unregistered) carries it as GET /v1/blocks?includeRetired=true lists it.

string format: date-time
publishedBy

Who published the version: a user, or a service token. Absent on a version published before it was recorded.

object
kind
required
string
Allowed values: user service
id
required
string
source

Where a block version came from: api (POST /v1/blocks), deploy (a deploy’s pack; id is the deployment’s) or suggested-change (id is the suggested change’s). Absent on a version published before it was recorded.

object
kind
required
string
Allowed values: api deploy suggested-change
id

Present for deploy and suggested-change.

string
Example
{
  "kind": "prompt",
  "content": {
    "parameters": [
      {
        "type": "string"
      }
    ]
  },
  "publishedBy": {
    "kind": "user"
  },
  "source": {
    "kind": "api"
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

block-not-found.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also