Get Results by ID

GET

api

session

get_by_id

cURL

curl --request GET \
  --url https://eu.whitecircle.com/api/session/get_by_id \
  --header 'Authorization: Bearer <token>' \
  --header 'whitecircle-version: <whitecircle-version>'

import requests

url = "https://eu.whitecircle.com/api/session/get_by_id"

headers = {
    "whitecircle-version": "<whitecircle-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'whitecircle-version': '<whitecircle-version>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://eu.whitecircle.com/api/session/get_by_id', 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://eu.whitecircle.com/api/session/get_by_id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "whitecircle-version: <whitecircle-version>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.whitecircle.com/api/session/get_by_id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("whitecircle-version", "<whitecircle-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu.whitecircle.com/api/session/get_by_id")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/session/get_by_id")

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

request = Net::HTTP::Get.new(url)
request["whitecircle-version"] = '<whitecircle-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "list": [
    {
      "flagged": true,
      "internal_session_id": "123e4567-e89b-12d3-a456-426614174000",
      "external_session_id": "user-session-001",
      "policies": {
        "70289e06-9111-463e-b121-7247c2b7bfbd": {
          "flagged": true,
          "flagged_source": [
            "text"
          ],
          "name": "No PII Sharing"
        }
      }
    }
  ]
}

Retrieve the results of a previously submitted content check request. Use this endpoint to look up policy check results using either your own tracking identifier or the system-generated ID.

Query Parameters

You must provide exactly one of the following identifiers: external_session_id or internal_session_id. Do not pass both.

Parameter	Required	Description
`internal_session_id`	✓*	The system-generated UUID returned in the content check response. This is always available, even if you didn’t provide an external session ID.
`external_session_id`	✓*	Your custom tracking identifier that you passed when checking content. Use this if you want to track sessions with your own IDs.
`deployment_id`		Override deployment resolved from API key. Defaults to the deployment associated with your API key.

*Exactly one of internal_session_id or external_session_id is required.

Example Requests

Using your external session ID:

curl -X GET "https://eu.whitecircle.com/api/session/get_by_id?deployment_id=your-deployment-id&external_session_id=user-session-123" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2025-12-01"

Using the internal session ID:

curl -X GET "https://eu.whitecircle.com/api/session/get_by_id?deployment_id=your-deployment-id&internal_session_id=123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2025-12-01"

Response

The endpoint returns a list of check results matching the provided session identifier. Each result includes:

flagged — Whether any policy violations were detected
internal_session_id — The system-generated UUID for the session
external_session_id — Your custom tracking ID (if provided during check)
policies — A map of policy IDs to their status, including whether each policy was violated

If you provided an external_session_id during the original check, use it here for easier lookups. Otherwise, store the internal_session_id from the check response.

Authorizations

Authorization

string

header

required

API Key required. Format: Bearer wc-your-api-key

Headers

whitecircle-version

string

required

API Version

Query Parameters

deployment_id

string | null

Optional deployment ID to validate session ownership

external_session_id

string | null

Find check results by external session ID (your tracking identifier)

internal_session_id

string | null

Find check results by internal session ID (system-generated UUID)

Response

Success

list

object[]

required

Hide child attributes

list.flagged

boolean

required

list.internal_session_id

string

required

list.policies

object

required

Hide child attributes

list.policies.{key}

object

Hide child attributes

list.policies.{key}.flagged

boolean

required

list.policies.{key}.flagged_source

enum<string>[]

required

Available options:

text,

image

list.policies.{key}.name

string

required

list.external_session_id

string | null

list.note

string | null

⌘I

cURL

curl --request GET \
  --url https://eu.whitecircle.com/api/session/get_by_id \
  --header 'Authorization: Bearer <token>' \
  --header 'whitecircle-version: <whitecircle-version>'

import requests

url = "https://eu.whitecircle.com/api/session/get_by_id"

headers = {
    "whitecircle-version": "<whitecircle-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'whitecircle-version': '<whitecircle-version>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://eu.whitecircle.com/api/session/get_by_id', 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://eu.whitecircle.com/api/session/get_by_id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "whitecircle-version: <whitecircle-version>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.whitecircle.com/api/session/get_by_id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("whitecircle-version", "<whitecircle-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu.whitecircle.com/api/session/get_by_id")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/session/get_by_id")

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

request = Net::HTTP::Get.new(url)
request["whitecircle-version"] = '<whitecircle-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "list": [
    {
      "flagged": true,
      "internal_session_id": "123e4567-e89b-12d3-a456-426614174000",
      "external_session_id": "user-session-001",
      "policies": {
        "70289e06-9111-463e-b121-7247c2b7bfbd": {
          "flagged": true,
          "flagged_source": [
            "text"
          ],
          "name": "No PII Sharing"
        }
      }
    }
  ]
}

First Steps

Use Cases

Integrations

Sessions

Artifacts

Policy

Metric

User

Query Parameters

Example Requests

Response

Authorizations

Headers

Query Parameters

Response

​Query Parameters

​Example Requests

​Response

Authorizations

Headers

Query Parameters

Response

Query Parameters

Example Requests

Response