app.bsky.draft.defs

bsky-lexicons.bsky.social

Documentation

draft object

A draft containing an array of draft posts.

Properties

langs array of stringlanguage Optional

Indicates human language of posts primary text content.

maxLength: 3 items
postgateEmbeddingRules array of union Optional

Embedding rules for the postgates to be created when this draft is published.

maxLength: 5 items
posts array of ref#draftPost Required

Array of draft posts that compose this draft.

maxLength: 100 itemsminLength: 1 items
View raw schema
{
  "type": "object",
  "required": [
    "posts"
  ],
  "properties": {
    "langs": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "language"
      },
      "maxLength": 3,
      "description": "Indicates human language of posts primary text content."
    },
    "posts": {
      "type": "array",
      "items": {
        "ref": "#draftPost",
        "type": "ref"
      },
      "maxLength": 100,
      "minLength": 1,
      "description": "Array of draft posts that compose this draft."
    },
    "threadgateAllow": {
      "type": "array",
      "items": {
        "refs": [
          "app.bsky.feed.threadgate#mentionRule",
          "app.bsky.feed.threadgate#followerRule",
          "app.bsky.feed.threadgate#followingRule",
          "app.bsky.feed.threadgate#listRule"
        ],
        "type": "union"
      },
      "maxLength": 5,
      "description": "Allow-rules for the threadgate to be created when this draft is published."
    },
    "postgateEmbeddingRules": {
      "type": "array",
      "items": {
        "refs": [
          "app.bsky.feed.postgate#disableRule"
        ],
        "type": "union"
      },
      "maxLength": 5,
      "description": "Embedding rules for the postgates to be created when this draft is published."
    }
  },
  "description": "A draft containing an array of draft posts."
}
draftEmbedCaption object

No description available.

Properties

content string Required

No description available.

maxLength: 10000 bytes
lang string language Required

A BCP-47 language tag (e.g., en, pt-BR).

View raw schema
{
  "type": "object",
  "required": [
    "lang",
    "content"
  ],
  "properties": {
    "lang": {
      "type": "string",
      "format": "language"
    },
    "content": {
      "type": "string",
      "maxLength": 10000
    }
  }
}
draftEmbedExternal object

No description available.

Properties

uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    }
  }
}
draftEmbedImage object

No description available.

Properties

alt string Optional

No description available.

maxGraphemes: 2000 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "localRef"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "maxGraphemes": 2000
    },
    "localRef": {
      "ref": "#draftEmbedLocalRef",
      "type": "ref"
    }
  }
}
draftEmbedLocalRef object

No description available.

Properties

path string Required

Local, on-device ref to file to be embedded. Embeds are currently device-bound for drafts.

maxLength: 1024 bytesminLength: 1 bytes
View raw schema
{
  "type": "object",
  "required": [
    "path"
  ],
  "properties": {
    "path": {
      "type": "string",
      "maxLength": 1024,
      "minLength": 1,
      "description": "Local, on-device ref to file to be embedded. Embeds are currently device-bound for drafts."
    }
  }
}
draftEmbedRecord object

No description available.

Properties

View raw schema
{
  "type": "object",
  "required": [
    "record"
  ],
  "properties": {
    "record": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    }
  }
}
draftEmbedVideo object

No description available.

Properties

alt string Optional

No description available.

maxGraphemes: 2000 graphemes
captions array of ref#draftEmbedCaption Optional

No description available.

maxLength: 20 items
View raw schema
{
  "type": "object",
  "required": [
    "localRef"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "maxGraphemes": 2000
    },
    "captions": {
      "type": "array",
      "items": {
        "ref": "#draftEmbedCaption",
        "type": "ref"
      },
      "maxLength": 20
    },
    "localRef": {
      "ref": "#draftEmbedLocalRef",
      "type": "ref"
    }
  }
}
draftPost object

One of the posts that compose a draft.

Properties

embedExternals array of ref#draftEmbedExternal Optional

No description available.

maxLength: 1 items
embedImages array of ref#draftEmbedImage Optional

No description available.

maxLength: 4 items
embedRecords array of ref#draftEmbedRecord Optional

No description available.

maxLength: 1 items
embedVideos array of ref#draftEmbedVideo Optional

No description available.

maxLength: 1 items
text string Required

The primary post content.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 3000,
      "description": "The primary post content.",
      "maxGraphemes": 300
    },
    "labels": {
      "refs": [
        "com.atproto.label.defs#selfLabels"
      ],
      "type": "union",
      "description": "Self-label values for this post. Effectively content warnings."
    },
    "embedImages": {
      "type": "array",
      "items": {
        "ref": "#draftEmbedImage",
        "type": "ref"
      },
      "maxLength": 4
    },
    "embedVideos": {
      "type": "array",
      "items": {
        "ref": "#draftEmbedVideo",
        "type": "ref"
      },
      "maxLength": 1
    },
    "embedRecords": {
      "type": "array",
      "items": {
        "ref": "#draftEmbedRecord",
        "type": "ref"
      },
      "maxLength": 1
    },
    "embedExternals": {
      "type": "array",
      "items": {
        "ref": "#draftEmbedExternal",
        "type": "ref"
      },
      "maxLength": 1
    }
  },
  "description": "One of the posts that compose a draft."
}
draftView object

View to present drafts data to users.

Properties

createdAt string datetime Required

The time the draft was created.

draft ref #draft Required

No description available.

id string tid Required

A TID to be used as a draft identifier.

updatedAt string datetime Required

The time the draft was last updated.

View raw schema
{
  "type": "object",
  "required": [
    "id",
    "draft",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "tid",
      "description": "A TID to be used as a draft identifier."
    },
    "draft": {
      "ref": "#draft",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "The time the draft was created."
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "The time the draft was last updated."
    }
  },
  "description": "View to present drafts data to users."
}
draftWithId object

A draft with an identifier, used to store drafts in private storage (stash).

Properties

draft ref #draft Required

No description available.

id string tid Required

A TID to be used as a draft identifier.

View raw schema
{
  "type": "object",
  "required": [
    "id",
    "draft"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "tid",
      "description": "A TID to be used as a draft identifier."
    },
    "draft": {
      "ref": "#draft",
      "type": "ref"
    }
  },
  "description": "A draft with an identifier, used to store drafts in private storage (stash)."
}

Lexicon Garden

@