v0.2.3-beta
logg inn registrer

brainful API-bibliotek

oversikt

Den brainful API muliggjør sømløs integrasjon mellom applikasjonene dine og brainful's kraftig innholdshåndteringssystem. Enten du bygger automatiseringsverktøy eller integrerer med favorittappene dine, vår RESTFUL API gir en enkel og sikker måte å samhandle med innholdet ditt på.

Hovedfunksjoner

Sikker autentisering

Token-basert autentisering med https-kryptering

RESTful design

Standard HTTP-metoder med JSON-respons

Plasserings støtte

Innebygde geolokaliseringsevner

Hastighetsbegrenset

Optimalisert for pålitelig ytelse

Brukstilfeller

Personlig automatisering

  • Automatisk lagre notater fra dine favorittapper
  • Opprett plasseringsbaserte innholdsutløsere
  • Koble med IFTTT/Zapier arbeidsflyter

Integreringsløsninger

  • Bygg tilpassede integreringer og utvidelser
  • Opprett automatiserte innholdsarbeidsflyter
  • Utvikle innholdsstyringssystemer

Krav

Begrensninger

60 forespørsler per minutt per bruker

Kom i gang

1

Få ditt API-token

Besøk din brainful innstillinger for å generere ditt API-token.

2

Velg din integreringsmetode

Velg fra vår eksempelkode i cURL, JavaScript, eller Python for å komme raskt i gang.

3

Gjør din første forespørsel

Prøv de interaktive eksemplene nedenfor for å teste integreringen din.

autentisering

Alle API-forespørsler krever ditt API-token i Authorization-hodet. Hent tokenet ditt fra brainful innstillinger. API-en støtter både token- og bearer token-formater.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

opprett blokk

POSThttps://brainful.dev/blocks/add

Forespørselsparametre

Alle parametre sendes i forespørselskroppen som JSON.

ParameterTypePåkrevdBeskrivelse
strengstrengJaInnhold som skal legges til (1-5000 tegn)
parent_luidstrengNeiluid av foreldreblokken (valgfritt)
latitudedesimaltallNeibreddegrad (-90° til 90°)
longitudedesimaltallNeilengdegrad (-180° til 180°)
agentstrengNeiAgent identifier (max 50 chars)
team_spacestrengNeiTeam space slug to add the block to (only for organization members)

Generated Request

Eksempel respons

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

Respons-felter

luid

Type: streng

Unik identifikator for det opprettede innholdet

slug

Type: streng

URL-friendly version of the content

words

Type: heltall

Number of words in the content

remaining_daily_quota

Type: heltall

Remaining content creation quota for today

Responskoder

201Opprettet (suksess)
400Ugyldig forespørsel (ugyldig streng)
401Uautorisert (ugyldig token)
403Forbidden (plan not sufficient)
422Invalid location coordinates

legg til i blokk

POSThttps://brainful.dev/blocks/append

Forespørselsparametre

Alle parametre sendes i forespørselskroppen som JSON.

ParameterTypePåkrevdBeskrivelse
identifierstrengJa Identifikator for blokken det skal legges til i (luid eller slug)
strengstrengJaInnhold som skal legges til (1-5000 tegn)

Generated Request

Eksempel respons

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

Respons-felter

luid

Type: streng

Unik identifikator for det opprettede innholdet

slug

Type: streng

URL-friendly version of the content

words

Type: heltall

Number of words in the content

remaining_daily_quota

Type: heltall

Remaining content creation quota for today

Responskoder

201Opprettet (suksess)
400Ugyldig forespørsel (ugyldig streng)
401Uautorisert (ugyldig token)
403Forbidden (plan not sufficient)

hent blokk

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

Forespørselsparametre

URL Parameters

ParameterTypePåkrevdBeskrivelse
luidstrengJaUnik identifikator for blokken som skal hentes

Forespørselskropp

ParameterTypePåkrevdBeskrivelse
latitudedesimaltallNeibreddegrad (-90° til 90°)
longitudedesimaltallNeilengdegrad (-180° til 180°)
agentstrengNei Agent-identifikator (maks 50 tegn)

Generated Request

Eksempel respons

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

Respons-felter

creator

Type: streng

Username of the content creator

luid

Type: streng

Unik identifikator for blokken

type

Type: streng

Innholdstype (f.eks., "thought")

html

Type: streng

HTML innhold i blokken

created_timestamp

Type: streng

Creation date and time

hits

Type: heltall

Number of views

Responskoder

200Suksess (blokk funnet)
401Uautorisert (ugyldig token)
403Forbidden (plan not sufficient)
404Ikke funnet (blokk ikke funnet)

Føl deg inspirert?

Ta en titt på noen av våre offisielle integrasjoner bygget med brainful User API her!