Read one part of a message

curl --request POST \
  --url https://bud.noetive.io/v1/part.describe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "message_01j9x2v8k3e0080000000000",
  "part": "2"
}
'

import requests

url = "https://bud.noetive.io/v1/part.describe"

payload = {
    "id": "message_01j9x2v8k3e0080000000000",
    "part": "2"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({id: 'message_01j9x2v8k3e0080000000000', part: '2'})
};

fetch('https://bud.noetive.io/v1/part.describe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://bud.noetive.io/v1/part.describe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 'message_01j9x2v8k3e0080000000000',
    'part' => '2'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://bud.noetive.io/v1/part.describe"

	payload := strings.NewReader("{\n  \"id\": \"message_01j9x2v8k3e0080000000000\",\n  \"part\": \"2\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://bud.noetive.io/v1/part.describe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"message_01j9x2v8k3e0080000000000\",\n  \"part\": \"2\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://bud.noetive.io/v1/part.describe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"message_01j9x2v8k3e0080000000000\",\n  \"part\": \"2\"\n}"

response = http.request(request)
puts response.read_body

{
  "ref": "<string>",
  "kind": "<string>",
  "text": "<string>",
  "content": {},
  "provenance": {
    "aligned": true,
    "in_workspace": true,
    "known": true,
    "spf": "<string>",
    "dkim": "<string>",
    "dmarc": "<string>",
    "thread_join": "new"
  },
  "cursor": "<string>",
  "truncated": true,
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

Attachments

Read one part of a message

An attachment or a body part, returned inline.

mode: text (the default) renders a part that is already text — text/*, JSON, XML, a forwarded message — the way a message body is rendered, under the same banner and with the same defences; HTML is converted to text. At most the first 2 MiB of the part is read: a longer one comes back cut, with truncated, and there is no cursor to continue from. Any other type is unavailable in this mode: read it with mode: bytes.

mode: bytes returns the part’s decoded bytes, standard base64, as content.bytes_base64, beside its type, filename and size. A part too large to return whole is refused with 422 policy_refused and guard: part_size rather than cut short. A message withheld because it carries malware refuses every part, in either mode, with guard: virus.

POST

part.describe

Read one part of a message

curl --request POST \
  --url https://bud.noetive.io/v1/part.describe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "message_01j9x2v8k3e0080000000000",
  "part": "2"
}
'

import requests

url = "https://bud.noetive.io/v1/part.describe"

payload = {
    "id": "message_01j9x2v8k3e0080000000000",
    "part": "2"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({id: 'message_01j9x2v8k3e0080000000000', part: '2'})
};

fetch('https://bud.noetive.io/v1/part.describe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://bud.noetive.io/v1/part.describe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 'message_01j9x2v8k3e0080000000000',
    'part' => '2'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://bud.noetive.io/v1/part.describe"

	payload := strings.NewReader("{\n  \"id\": \"message_01j9x2v8k3e0080000000000\",\n  \"part\": \"2\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://bud.noetive.io/v1/part.describe")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"message_01j9x2v8k3e0080000000000\",\n  \"part\": \"2\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://bud.noetive.io/v1/part.describe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"message_01j9x2v8k3e0080000000000\",\n  \"part\": \"2\"\n}"

response = http.request(request)
puts response.read_body

{
  "ref": "<string>",
  "kind": "<string>",
  "text": "<string>",
  "content": {},
  "provenance": {
    "aligned": true,
    "in_workspace": true,
    "known": true,
    "spf": "<string>",
    "dkim": "<string>",
    "dmarc": "<string>",
    "thread_join": "new"
  },
  "cursor": "<string>",
  "truncated": true,
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

{
  "error": {
    "code": "invalid",
    "message": "<string>",
    "hint": "<string>",
    "field": "/id",
    "guard": "<string>",
    "counter": "<string>",
    "request_id": "<string>",
    "retry_after_ms": 123
  },
  "ref": "<string>",
  "kind": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer credential for one agent: an API key or an access token (a JWT). Pass as Authorization: Bearer <credential>.

A key is shown once when it is issued and is not recoverable afterwards; an access token lives five minutes and is fetched with the agent's own client key from the access service. Treat both as secrets: they reach one agent's mail, and anything a delegation has extended to it. An access token's scope is a ceiling on what the agent may do with it.

Body

application/json

string

required

The message the part belongs to.

Example:

"message_01j9x2v8k3e0080000000000"

part

string

required

The part number, as render: parts on message.describe lists it.

Example:

"2"

mode

enum<string>

text (the default) or bytes; see the operation. message, to read a forwarded message as its own object, is unavailable.

Available options:

text,

bytes,

message

Response

The object.

ref

string

What was read, as the server understood it.

kind

string

Which shape this is, so a client can branch without re-parsing.

text

string

The rendering, for the kinds that have one.

content

object

The structured form, for the kinds that have one. Its shape depends on kind.

provenance

object

Where the content came from. Kept apart from the rendering on purpose: a client that refuses unauthenticated mail should not have to read prose to find out, and prose is the part a sender influences.

Show child attributes

cursor

string

Present when there is more to read.

truncated

boolean

There is more than this response carries.

error

object

Show child attributes

Discovery

Mail

Send

Attachments

Events

Health

Read one part of a message

Authorizations

Body

Response