Get published content type metadata

post

https://api.andesine.app/type-metadata/published

Read-only bulk metadata for type generation. Resolves a channel once (published by default), or reads a retained snapshot. Uses publication paths, names, and exact entry-version schema revisions; never substitutes current schemas. Supports mixed revisions and schema-free entries. Empty collections use general types without warnings. Includes selected subtrees; no selectors means all published collections and root entries. Publication-access rules match content.get. No entry content is loaded. Reuse source.snapshotID for related reads. The fingerprint changes only when returned type metadata changes, not when content-only publication creates a new snapshot.

Required API key permissions: read:publishing. Write permissions also grant read access for the same resource.

Authentication

apiKeyhttp, bearer, Andesine API key

Use an Andesine API key as a Bearer token

oauthhttp, bearer, Andesine OAuth access token

Use an OAuth access token with andesine:api scope. Send x-workspace-id for workspace operations. Current user permissions apply.

Headers

x-workspace-idstring

Required for OAuth: ID of the workspace to access. API keys use their own workspace.

Request body *

application/json

Bodyobject

5 fields

collectionsarray of any of

Collection IDs, name paths, or objects with collectionSlugPath. Includes selected subtrees; empty selects all accessible collections.

Default: []

Options

Any of

Option 1string

Option 2string

Decoded content path, such as /Docs/Page or coll_ID/Page. Names are case-sensitive. Do not URL-encode names before passing them to the SDK.

Option 3object

collectionSlugPath*string

Decoded derived slug path, such as /docs/getting-started or coll_ID/getting-started. Use the returned slugPath without URL encoding.

includeEntriesboolean

Include entry IDs, names, paths, and schema associations.

Default: false

includeTreeboolean

Include ordered child IDs for each collection. Also includes entry metadata.

Default: false

channelPublishingChannelCode

snapshotIDstring

Responses

200OKapplication/json

Bodyobject

8 fields

formatVersion*constant

Value: 1

workspaceID*string

source*any of

Options

Any of

Option 1object

kind*constant

Value: "current"

Option 2object

kind*constant

Value: "published"

channel*PublishingChannelCode

snapshotID*string

expiresAt*any of

Options

Any of

Option 1string (date-time)

Option 2null

fingerprint*string

Deterministic hash of returned type metadata and source kind. Excludes publication snapshot IDs, expiry, content bodies, and unrequested entry/tree data.

collections*array of TypeMetadataCollection

6 fields

id*any of

Null identifies the virtual root at /.

Options

Any of

Option 1string

Option 2null

parentID*any of

Options

Any of

Option 1string

Option 2null

name*string

path*string

slugPath*string

schemaRevisionIDs*array of any of

Effective schema revisions for this collection. Null represents schema-free content. An empty array has no recorded schema evidence; use a general type without a warning.

Options

Any of

Option 1string

Option 2null

revisions*array of SchemaRevision

Distinct effective definitions, including inherited fields, referenced by collections or entries.

3 fields

revisionID*string

Recorded effective schema revision

hash*string

Hash of the effective schema definition

definition*object

Exact effective definition, including inherited fields

2 fields

formatVersion*constant

Value: 1

fields*array of SchemaField

Options

Any of

SchemaPropertyobject

id*string

kind*constant

Value: "property"

label*string

type*string

One of: "text", "number", "checkbox", "date", "url", "select", "multi-select"

initialValue*SchemaPropertyValue

Options

Any of

Option 1boolean

Option 2string

Option 3array of string

options*array of string

optionalboolean

SchemaFragmentobject

id*string

kind*constant

Value: "fragment"

label*string

allowedBlocks*array of SchemaBlockType

initialContent*array of ContentNode

5 fields

type*string

attrsobject

1 field

{key}any

contentarray of ContentNode

Repeats ContentNode

marksarray of ContentMark

2 fields

type*string

attrsobject

1 field

{key}any

textstring

optionalboolean

entriesarray of TypeMetadataEntry

6 fields

id*string

collectionID*any of

Options

Any of

Option 1string

Option 2null

name*string

path*string

slugPath*string

schemaRevisionID*any of

Options

Any of

Option 1string

Option 2null

treearray of TypeMetadataTree

3 fields

collectionID*any of

Options

Any of

Option 1string

Option 2null

collectionIDs*array of string

Selected direct children in display order.

entryIDs*array of string

Direct entries in display order.

400Bad Requestapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "BAD_REQUEST"

status*constant

Value: 400

message*string

Default: "Bad Request"

dataValidationErrorData

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

issuesarray of ValidationIssue

3 fields

message*string

codestring

patharray of any of

Options

Any of

Option 1string

Option 2number

Option 3object

key*any of

Options

Any of

Option 1string

Option 2number

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

401Unauthorizedapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "UNAUTHORIZED"

status*constant

Value: 401

message*string

Default: "Unauthorized"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

403Forbiddenapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "FORBIDDEN"

status*constant

Value: 403

message*string

Default: "Forbidden"

dataForbiddenErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

missingPermissionsarray of string

requiredPlanconstant

Value: "pro"

actionstring

The requested action that was denied

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

404Not Foundapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "NOT_FOUND"

status*constant

Value: 404

message*string

Default: "Not Found"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

409Conflictapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "CONFLICT"

status*constant

Value: 409

message*string

Default: "Conflict"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

429Too Many Requestsapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "TOO_MANY_REQUESTS"

status*constant

Value: 429

message*string

Default: "Too Many Requests"

dataRateLimitErrorData

3 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

limitstring

The limit that was reached: a short-term rate limit, or a monthly API call, AI credit, or spending limit

One of: "rate", "api-calls", "ai-credits", "spending"

retryAfterSecondsnumber

Minimum delay before another attempt, in seconds. Also sent in Retry-After.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

500Internal Server Errorapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "INTERNAL_SERVER_ERROR"

status*constant

Value: 500

message*string

Default: "Internal Server Error"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

503Service Unavailableapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "SERVICE_UNAVAILABLE"

status*constant

Value: 503

message*string

Default: "Service Unavailable"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

Request

bash

curl --request POST \
  --url 'https://api.andesine.app/type-metadata/published' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "channel": "published",
  "collections": [
    "/Tutorials"
  ]
}'

javascript

const response = await fetch("https://api.andesine.app/type-metadata/published", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "channel": "published",
    "collections": [
      "/Tutorials"
    ]
  })
});

const data = await response.json();

python

import requests

response = requests.post(
    "https://api.andesine.app/type-metadata/published",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "channel": "published",
        "collections": [
            "/Tutorials",
        ],
    },
)

print(response.json())

typescript

import { createClient } from "@andesine/sdk";

const client = createClient({ apiKey: process.env.ANDESINE_API_KEY });

await client.typeMetadata.getPublished({
  channel: "published",
  collections: [
    "/Tutorials"
  ]
});

Response

json

{
  "formatVersion": 1,
  "workspaceID": "string",
  "source": {
    "kind": "current"
  },
  "fingerprint": "string",
  "collections": [
    {
      "id": "string",
      "parentID": "string",
      "name": "string",
      "path": "string",
      "slugPath": "string",
      "schemaRevisionIDs": [
        "string"
      ]
    }
  ],
  "revisions": [
    {
      "revisionID": "string",
      "hash": "string",
      "definition": {
        "formatVersion": 1,
        "fields": [
          {
            "id": "string",
            "kind": "property",
            "label": "string",
            "type": "text",
            "initialValue": true,
            "options": [
              "string"
            ],
            "optional": true
          }
        ]
      }
    }
  ],
  "entries": [
    {
      "id": "string",
      "collectionID": "string",
      "name": "string",
      "path": "string",
      "slugPath": "string",
      "schemaRevisionID": "string"
    }
  ],
  "tree": [
    {
      "collectionID": "string",
      "collectionIDs": [
        "string"
      ],
      "entryIDs": [
        "string"
      ]
    }
  ]
}

json

{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": {
    "hints": [
      "string"
    ],
    "issues": [
      {
        "message": "string",
        "code": "string",
        "path": [
          "string"
        ]
      }
    ]
  }
}

json

{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": {
    "hints": [
      "string"
    ],
    "missingPermissions": [
      "string"
    ],
    "requiredPlan": "pro",
    "action": "string"
  }
}

json

{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "Conflict",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "Too Many Requests",
  "data": {
    "hints": [
      "string"
    ],
    "limit": "rate",
    "retryAfterSeconds": 0
  }
}

json

{
  "defined": true,
  "code": "INTERNAL_SERVER_ERROR",
  "status": 500,
  "message": "Internal Server Error",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "Service Unavailable",
  "data": {
    "hints": [
      "string"
    ]
  }
}