Create statements in batch

Stores and indexes the uploaded statements in one request, all under the same graph when graph_id is given, and can issue a verifiable credential for each. Results are returned in the order the statements were sent. With graph_id the caller needs create_declarations on the graph's project; without it, in at least one project. The statements are written concurrently without issue_vc, and one at a time with it. Either way a failure does not roll back the ones already written, so a refused batch may have stored some of its statements.

puthttps://<host>/statements/v1/batch

bash

curl --request PUT \
  --url 'https://<host>/statements/v1/batch' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"generate_id":"false","graph_id":"00000000-0000-0000-0000-000000000000","issue_vc":"false","statements":[]}'

javascript

const response = await fetch("https://<host>/statements/v1/batch", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "generate_id": "false",
    "graph_id": "00000000-0000-0000-0000-000000000000",
    "issue_vc": "false",
    "statements": []
  })
});

const data = await response.json();

typescript

interface StatementsBatchCreateResponse {
  results: Record<string, unknown>[];
}

const response = await fetch("https://<host>/statements/v1/batch", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "generate_id": "false",
    "graph_id": "00000000-0000-0000-0000-000000000000",
    "issue_vc": "false",
    "statements": []
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: StatementsBatchCreateResponse = await response.json();

python

import requests

response = requests.put(
    "https://<host>/statements/v1/batch",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "generate_id": "false",
        "graph_id": "00000000-0000-0000-0000-000000000000",
        "issue_vc": "false",
        "statements": [],
    },
)
response.raise_for_status()
print(response.json())

package main

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

func main() {
	body := strings.NewReader(`{
	  "generate_id": "false",
	  "graph_id": "00000000-0000-0000-0000-000000000000",
	  "issue_vc": "false",
	  "statements": []
	}`)
	req, err := http.NewRequest(http.MethodPut, "https://<host>/statements/v1/batch", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}

java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://<host>/statements/v1/batch"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("PUT", HttpRequest.BodyPublishers.ofString("""
                {
                  "generate_id": "false",
                  "graph_id": "00000000-0000-0000-0000-000000000000",
                  "issue_vc": "false",
                  "statements": []
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

csharp

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://<host>/statements/v1/batch");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "generate_id": "false",
      "graph_id": "00000000-0000-0000-0000-000000000000",
      "issue_vc": "false",
      "statements": []
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

php

<?php

$ch = curl_init('https://<host>/statements/v1/batch');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "generate_id": "false",
      "graph_id": "00000000-0000-0000-0000-000000000000",
      "issue_vc": "false",
      "statements": []
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;

ruby

require "net/http"

uri = URI("https://<host>/statements/v1/batch")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "generate_id": "false",
    "graph_id": "00000000-0000-0000-0000-000000000000",
    "issue_vc": "false",
    "statements": []
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"

rust

// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .put("https://<host>/statements/v1/batch")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "generate_id": "false",
            "graph_id": "00000000-0000-0000-0000-000000000000",
            "issue_vc": "false",
            "statements": []
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

BearerAuth · HTTP bearer (JWT)

Request bodyrequired

application/json

generate_idboolean | null
If true, the service computes each statement's CID and inserts it as statement.@id. If omitted or false, each submitted statement must already include a matching @id field.
graph_idstring | null
The uuid of the graph to register every statement under.
issue_vcboolean | null
Set to true to create a verifiable credential for each statement.
statementsany[]required
Integrity statement JSON documents. Provide an @id field in each unless generate_id is set to true.

Examplejson

{
  "generate_id": "false",
  "graph_id": "00000000-0000-0000-0000-000000000000",
  "issue_vc": "false",
  "statements": []
}

Responses

200Statements stored and indexed

application/json

resultsStatementsBatchCreateResponseItem[]required
Show properties
Array of StatementsBatchCreateResponseItem
- jcs_cidstringrequired
- rdfc_cidstringrequired
- statement_idstringrequired

Examplejson

{
  "results": [
    {
      "jcs_cid": "string",
      "rdfc_cid": "string",
      "statement_id": "string"
    }
  ]
}

400A submitted statement is not a JSON object, fails JSON-LD expansion, is not a known statement type, is missing `@id` while `generate_id` is unset, a provided `@id` does not match the computed statement CID, or (only without authentication) the specified `graph_id` has not been registered. Register missing graphs at PUT "/graph/v1/"

application/json

callstackobject
Show properties
object | null
errorstringrequired

Examplejson

{
  "callstack": {},
  "error": "string"
}

401Missing or invalid bearer token

application/json

callstackobject
Show properties
object | null
errorstringrequired

Examplejson

{
  "callstack": {},
  "error": "string"
}

403Caller lacks create_declarations on the graph's project (or in any project when no graph_id is given), or graph_id is not registered

application/json

callstackobject
Show properties
object | null
errorstringrequired

Examplejson

{
  "callstack": {},
  "error": "string"
}

500Internal error

application/json

callstackobject
Show properties
object | null
errorstringrequired

Examplejson

{
  "callstack": {},
  "error": "string"
}

503Auth Service or blob storage unavailable

application/json

callstackobject
Show properties
object | null
errorstringrequired

Examplejson

{
  "callstack": {},
  "error": "string"
}