Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.postiz.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Settings Schema

When creating a post for Nostr, use the following settings schema: 
{
  "settings": {
    "__type": "nostr"
  }
}
Nostr has no provider-specific settings beyond __type. The relays that the note publishes to are determined by the connected integration, not the settings block. Post content, images, and the schedule are configured at the post level - see the Create Post reference.

​
Fields

FieldTypeRequiredDescription
__typestringYesMust be nostr

​
Complete Example

​
Text Note

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-nostr-integration-id"
      },
      "value": [
        {
          "content": "Hello from the Postiz API!",
          "image": []
        }
      ],
      "settings": {
        "__type": "nostr"
      }
    }
  ]
}

​
Note with Image

{
  "type": "now",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-nostr-integration-id"
      },
      "value": [
        {
          "content": "Sharing today's launch screenshot",
          "image": [
            {
              "id": "image-id",
              "path": "https://uploads.postiz.com/launch.png"
            }
          ]
        }
      ],
      "settings": {
        "__type": "nostr"
      }
    }
  ]
}