v0.2.3-beta
logga in registrera

brainful API-bibliotek

översikt

Den brainful API möjliggör sömlös integration mellan era applikationer och brainful's kraftfullt innehållshanteringssystem. Oavsett om ni bygger automationsverktyg eller integrerar med era favoritappar, vårt RESTFUL API tillhandahåller ett enkelt och säkert sätt att interagera med ert innehåll.

Nyckelfunktioner

Säker autentisering

Tokenbaserad autentisering med HTTPS-kryptering

RESTful design

Standard HTTP-metoder med JSON-svar

Platsstöd

Inbyggda geolokaliseringsmöjligheter

Hastighetsbegränsad

Optimerad för tillförlitlig prestanda

Användningsfall

Personlig automation

  • Spara anteckningar automatiskt från era favoritappar
  • Skapa platsbaserade innehållsutlösare
  • Anslut till IFTTT/Zapier arbetsflöden

Integrationslösningar

  • Bygg anpassade integrationer och tillägg
  • Skapa automatiserade innehållsarbetsflöden
  • Utveckla innehållshanteringssystem

Krav

Hastighetsbegränsningar

60 förfrågningar per minut per användare

Komma igång

1

Hämta er API-token

Besök er brainful inställningssida för att generera er API-token.

2

Välj er integrationsmetod

Välj från vår exempelkod i cURL, JavaScript, eller Python för att komma igång snabbt.

3

Gör er första förfrågan

Prova de interaktiva exemplen nedan för att testa er integration.

autentisering

Alla API-förfrågningar kräver er API-token i Authorization-headern. Hämta er token från brainful inställningssida. API:et stöder både token- och bearer token-format.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

skapa block

POSThttps://brainful.dev/blocks/add

Förfrågansparametrar

Alla parametrar skickas i förfråganskroppen som JSON.

ParameterTypObligatoriskBeskrivning
strängsträngJaInnehåll att lägga till (1-5000 tecken)
parent_luidsträngNejluid av föräldra-blocket (valfritt)
latitudeflyttalNejlatitud (-90° till 90°)
longitudeflyttalNejlongitud (-180° till 180°)
agentsträngNejAgent identifier (max 50 chars)
team_spacesträngNejTeam space slug to add the block to (only for organization members)

Generated Request

Exempelsvar

{
                    "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
                  }

Svarsfält

luid

Typ: sträng

Unik identifierare för det skapade innehållet

slug

Typ: sträng

URL-friendly version of the content

words

Typ: heltal

Number of words in the content

remaining_daily_quota

Typ: heltal

Remaining content creation quota for today

Svarskoder

201Skapad (framgång)
400Felaktig begäran (ogiltig sträng)
401Obehörig (ogiltig token)
403Forbidden (plan not sufficient)
422Invalid location coordinates

lägg till i block

POSThttps://brainful.dev/blocks/append

Förfrågansparametrar

Alla parametrar skickas i förfråganskroppen som JSON.

ParameterTypObligatoriskBeskrivning
identifiersträngJa Identifierare för blocket att lägga till i (luid eller slug)
strängsträngJaInnehåll att läggas till (1-5000 tecken)

Generated Request

Exempelsvar

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

Svarsfält

luid

Typ: sträng

Unik identifierare för det skapade innehållet

slug

Typ: sträng

URL-friendly version of the content

words

Typ: heltal

Number of words in the content

remaining_daily_quota

Typ: heltal

Remaining content creation quota for today

Svarskoder

201Skapad (framgång)
400Felaktig begäran (ogiltig sträng)
401Obehörig (ogiltig token)
403Forbidden (plan not sufficient)

hämta block

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

Förfrågansparametrar

URL Parameters

ParameterTypObligatoriskBeskrivning
luidsträngJaUnik identifierare för blocket som ska hämtas

Begäranskropp

ParameterTypObligatoriskBeskrivning
latitudeflyttalNejlatitud (-90° till 90°)
longitudeflyttalNejlongitud (-180° till 180°)
agentsträngNej Agentidentifierare (max 50 tecken)

Generated Request

Exempelsvar

{
  "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 }

Svarsfält

creator

Typ: sträng

Username of the content creator

luid

Typ: sträng

Unik identifierare för blocket

type

Typ: sträng

Innehållstyp (t.ex., "thought")

html

Typ: sträng

HTML innehållet i blocket

created_timestamp

Typ: sträng

Creation date and time

hits

Typ: heltal

Number of views

Svarskoder

200Framgång (block hittades)
401Obehörig (ogiltig token)
403Forbidden (plan not sufficient)
404Hittades inte (block hittades inte)

Känn er inspirerade?

Ta en titt på några av våra officiella integrationer byggda med brainful User API här!