Dokumenter - Utviklere

Notater

Ekspertnivå

The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.

List

API endpoint:

GET

https://ai.planr.no/api/v1/documents

Request example:

curl --location --request GET 'https://ai.planr.no/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameter

Type

Beskrivelse

search

optional string

Søket.

search_by

optional string

Søk etter. Mulige verdier er: name for Navn, result for Resultat. Vanlig: name.

template_id

optional integer

Filtrer etter mal-ID. Mulige verdier er: 1 for Freestyle, 2 for Om oss, 3 for Annonsering, 4 for Avansert artikkel, 5 for Innledning, 6 for Bloggoversikt, 7 for Avslutning, 8 for Bloggavsnitt, 9 for Enkel artikkel, 10 for Seksjoner, 11 for Snakkepunkter på bloggen, 12 for Tittel, 13 for Oppfordring til handling (CTA), 14 for Omskrivning, 15 for Oppsummering, 16 for FAQ, 17 for Hashtags, 18 for Overskrift, 19 for Hvordan det fungerer, 20 for Metabeskrivelse, 21 for Meta nøkkelord, 22 for Målsetninger, 23 for Nyhetsbrev, 24 for Smerte-agitere-løsning, 25 for Avsnitt med nøkkelord, 26 for Pressemeldinger, 27 for Sosialt innlegg, 28 for Bildetekst for sosiale innlegg, 29 for Oppstartsideer, 30 for Oppstartsnavn, 31 for Underoverskrift, 32 for Omtaler, 33 for Tweet, 34 for Twitter thread, 35 for Verdiforslag, 36 for Videoinnhold, 37 for Videomanus, 38 for Videotagger, 39 for Videotittel, 40 for Visjonserklæring, 43 for Product sheet, 44 for Welcome email, 45 for Push notification, 46 for Blog listicle, 47 for Content grammar, 48 for Blog tags, 49 for Pros and cons, 50 for Google advertisement, 51 for Facebook advertisement, 52 for Job description, 53 for Review, 54 for Feature section. Vanlig: freestyle.

favorite

optional boolean

Filtrer etter favoritt.

sort_by

optional string

Sort by. Mulige verdier er: id for Date created, name for Navn. Vanlig: id.

sort

optional string

Sorter. Mulige verdier er: desc for Descending, asc for Ascending. Vanlig: desc.

per_page

optional integer

Resultater per side. Mulige verdier er: 10, 25, 50, 100. Vanlig: 10.

Show

API endpoint:

GET

https://ai.planr.no/api/v1/documents/{id}

Request example:

curl --location --request GET 'https://ai.planr.no/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Store

API endpoint:

POST

https://ai.planr.no/api/v1/documents

Request example:

curl --location --request POST 'https://ai.planr.no/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'

Parameter

Type

Beskrivelse

name

required string

The document name.

prompt

required string

Intruksjonene for Planr AI.

creativity

required float

The creative level of the result. Mulige verdier er: 0 for Repeterende, 0.25 for Deterministisk, 0.5 for Original (Anbefales), 0.75 for Kreativ, 1 for Fantasifull. Vanlig: 0.5.

Update

API endpoint:

PUT PATCH

https://ai.planr.no/api/v1/documents/{id}

Request example:

curl --location --request PUT 'https://ai.planr.no/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parameter

Type

Beskrivelse

name

optional string

The document name.

result

optional string

Dokumentresultatet.

favorite

optional boolean

Om dokumentet er favoritt eller ikke.

Slett

API endpoint:

DELETE

https://ai.planr.no/api/v1/documents/{id}

Request example:

curl --location --request DELETE 'https://ai.planr.no/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'