v0.2.3-beta
Anmelden Registrieren

brainful API-Bibliothek

Übersicht

Die brainful API enables seamless integration between your applications and brainful's leistungsstark content management system. Whether you're building automation tools or integrating with your favorite apps, unsere RESTFUL API provides a simple and secure way to interact with your content.

Hauptmerkmale

Sichere Authentifizierung

Token-based authentication with https encryption

Restful design

Standard http methods with json responses

Standortunterstützung

Built-in geolocation capabilities

Ratenbegrenzt

Optimised for reliable performance

Use cases

Personal automation

  • Auto-save notes from your favorite apps
  • Create location-based content triggers
  • Verbinden mit IFTTT/Zapier Arbeitsabläufe

Integrationslösungen

  • Build custom integrations and extensions
  • Create automated content workflows
  • Develop content management systems

Anforderungen

Ratenbegrenzungen

60 requests per minute per user

Erste Schritte

1

Get your api token

Visit your brainful Optionsseite to generate your api token.

2

Choose your integration method

Select from our example code in cURL, JavaScript, oder Python um schnell zu beginnen.

3

Make your first request

Try out the interactive examples below to test your integration.

Authentifizierung

All API requests require your API token in the Authorization header. Get your token from the brainful Optionsseite. The api supports both token and bearer token formats.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

Block erstellen

POSThttps://brainful.dev/blocks/add

Anfrageparameter

All parameters are sent in the request body as JSON.

ParameterTypeErforderlichBeschreibung
stringstringJaHinzuzufügender Inhalt (1-5000 Zeichen)
parent_luidstringNeinluid des übergeordneten Blocks (optional)
latitudefloatNeinlatitude (-90° zu 90°)
longitudefloatNeinlongitude (-180° zu 180°)
agentstringNeinAgent identifier (max 50 chars)
team_spacestringNeinTeam space slug to add the block to (only for organization members)

Generated Request

Example response

{
                    "luid": "abc123",
                    "slug": "My New Block",
                    "type": "thought",
                    "pinned": false,
                    "entities": [],
                    "created_timestamp": "2024-01-01T00:00:00Z",
                    "last_edited": "2024-01-01T00:00:00Z",
                    "experience": 5,
                    "remaining_daily_quota": 97
                  }

Response fields

luid

Type: string

Unique identifier for the created content

slug

Type: string

URL-friendly version of the content

words

Type: Ganzzahl

Number of words in the content

remaining_daily_quota

Type: Ganzzahl

Remaining content creation quota for today

Response codes

201Erstellt (Erfolg)
400Bad request (ungültige Zeichenkette)
401Unauthorised (ungültiges Token)
403Forbidden (plan not sufficient)
422Invalid location coordinates

an Block anhängen

POSThttps://brainful.dev/blocks/append

Anfrageparameter

All parameters are sent in the request body as JSON.

ParameterTypeErforderlichBeschreibung
identifierstringJa Bezeichner des Blocks, an den angehängt werden soll (luid oder slug)
stringstringJaAnzuhängender Inhalt (1-5000 Zeichen)

Generated Request

Example response

{
  "details": "Text appended to block successfully.",
  "luid": "abc123",
  "slug": "my-example-block"
}

Response fields

luid

Type: string

Unique identifier for the created content

slug

Type: string

URL-friendly version of the content

words

Type: Ganzzahl

Number of words in the content

remaining_daily_quota

Type: Ganzzahl

Remaining content creation quota for today

Response codes

201Erstellt (Erfolg)
400Bad request (ungültige Zeichenkette)
401Unauthorised (ungültiges Token)
403Forbidden (plan not sufficient)

Block abrufen

GEThttps://brainful.dev/blocks/get/{luid}

Anfrageparameter

URL Parameters

ParameterTypeErforderlichBeschreibung
luidstringJaUnique identifier of the block to retrieve

Anfragekörper

ParameterTypeErforderlichBeschreibung
latitudefloatNeinlatitude (-90° zu 90°)
longitudefloatNeinlongitude (-180° zu 180°)
agentstringNein Agent-Bezeichner (max 50 chars)

Generated Request

Example response

{
  "creator": "johnnyappleseed",
  "luid": "abc123",
  "slug": "My New Block",
  "type": "thought",
  "html": "

My New Block

", "blocks": [], "entities": [], "flagged": false, "pinned": false, "archived": false, "trashed": false, "public": false, "created_timestamp": "2025-01-28 18:01", "last_edited": "2025-01-28 18:01", "words": 3, "bytes": 45, "hits": 0 }

Response fields

creator

Type: string

Username of the content creator

luid

Type: string

Unique identifier for the block

type

Type: string

Inhaltstyp (e.g., "thought")

html

Type: string

HTML Inhalt des Blocks

created_timestamp

Type: string

Creation date and time

hits

Type: Ganzzahl

Number of views

Response codes

200Erfolg (Block gefunden)
401Unauthorised (ungültiges Token)
403Forbidden (plan not sufficient)
404Nicht gefunden (Block nicht gefunden)

Lassen Sie sich inspirieren?

Take a look at some of our official integrations built with brainful User APITake a look at some of our official integrations built with brainful User API here!