Create an annotation

POST

/api/v1/annotations

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "http://127.0.0.1:58259/api/v1/annotations");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"bookId\": 1, \"cfi\": \"example\", \"text\": \"example\", \"color\": \"example\", \"style\": \"example\", \"note\": \"example\", \"chapterTitle\": \"example\" }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("http://127.0.0.1:58259/api/v1/annotations"),
    Content = new StringContent("{ \"bookId\": 1, \"cfi\": \"example\", \"text\": \"example\", \"color\": \"example\", \"style\": \"example\", \"note\": \"example\", \"chapterTitle\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "http://127.0.0.1:58259/api/v1/annotations"

  payload := strings.NewReader("{ \"bookId\": 1, \"cfi\": \"example\", \"text\": \"example\", \"color\": \"example\", \"style\": \"example\", \"note\": \"example\", \"chapterTitle\": \"example\" }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://127.0.0.1:58259/api/v1/annotations"))
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"bookId\": 1, \"cfi\": \"example\", \"text\": \"example\", \"color\": \"example\", \"style\": \"example\", \"note\": \"example\", \"chapterTitle\": \"example\" }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"bookId\": 1, \"cfi\": \"example\", \"text\": \"example\", \"color\": \"example\", \"style\": \"example\", \"note\": \"example\", \"chapterTitle\": \"example\" }");
Request request = new Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/annotations")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'http://127.0.0.1:58259/api/v1/annotations',
  headers: {'Content-Type': 'application/json'},
  data: {
    bookId: 1,
    cfi: 'example',
    text: 'example',
    color: 'example',
    style: 'example',
    note: 'example',
    chapterTitle: 'example'
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'http://127.0.0.1:58259/api/v1/annotations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"bookId":1,"cfi":"example","text":"example","color":"example","style":"example","note":"example","chapterTitle":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"bookId\": 1, \"cfi\": \"example\", \"text\": \"example\", \"color\": \"example\", \"style\": \"example\", \"note\": \"example\", \"chapterTitle\": \"example\" }")
val request = Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/annotations")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "http://127.0.0.1:58259/api/v1/annotations";

    let payload = json!({
        "bookId": 1,
        "cfi": "example",
        "text": "example",
        "color": "example",
        "style": "example",
        "note": "example",
        "chapterTitle": "example"
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url http://127.0.0.1:58259/api/v1/annotations \
  --header 'Content-Type: application/json' \
  --data '{ "bookId": 1, "cfi": "example", "text": "example", "color": "example", "style": "example", "note": "example", "chapterTitle": "example" }'

wget --quiet \
  --method POST \
  --header 'Content-Type: application/json' \
  --body-data '{ "bookId": 1, "cfi": "example", "text": "example", "color": "example", "style": "example", "note": "example", "chapterTitle": "example" }' \
  --output-document \
  - http://127.0.0.1:58259/api/v1/annotations

Create a new annotation (highlight, underline, etc.) for a book.

Request Body^required

application/json

Annotation creation request

object

bookId

required

integer format: int64

cfi

required

string

0 <= 1000 characters

text

required

string

0 <= 5000 characters

color

string

/^#[0-9A-Fa-f]{6}$/

style

string

/^(highlight|underline|strikethrough|squiggly)$/

note

string

0 <= 5000 characters

chapterTitle

string

0 <= 500 characters

Example ^generated

{
  "bookId": 1,
  "cfi": "example",
  "text": "example",
  "color": "example",
  "style": "example",
  "note": "example",
  "chapterTitle": "example"
}

Responses

200

Annotation created successfully

*/*

object

integer format: int64

userId

integer format: int64

bookId

integer format: int64

cfi

string

text

string

color

string

style

string

note

string

chapterTitle

string

createdAt

string format: date-time

updatedAt

string format: date-time

Create an annotation

Request Body required

Example generated

Responses

200

Request Body^required

Example ^generated