Get Results

GET

api

session

{internal_session_id}

cURL

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

import requests

url = "https://eu.whitecircle.com/api/session/{internal_session_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/{internal_session_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/{internal_session_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/{internal_session_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/{internal_session_id}")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/session/{internal_session_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

{
  "session": {
    "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"
      }
    }
  },
  "artifacts": [
    {
      "flagged": true,
      "policies": {
        "70289e06-9111-463e-b121-7247c2b7bfbd": {
          "flagged": true,
          "flagged_source": [
            "image"
          ],
          "name": "No PII Sharing"
        }
      },
      "kind": "image",
      "status": "completed",
      "updated_at": "2026-04-15T12:00:00Z",
      "internal_artifact_id": "223e4567-e89b-12d3-a456-426614174000",
      "external_artifact_id": "artifact-001",
      "external_session_id": "user-session-001",
      "internal_session_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-04-15T12:00:00Z"
    }
  ]
}

Retrieve the results of a previously submitted content check. You can look up a session either by its internal ID path or by your external ID query. Both lookup styles return the same { session, artifacts } envelope as POST /api/session.

Route Shapes

Use one of these routes:

Route	Use when
`GET /api/session/{internal_session_id}`	You have the system-generated session ID from a previous response
`GET /api/session?external_session_id=...`	You want to look up the latest matching session by your own external ID

deployment_id remains optional on both routes. If you omit it, White Circle uses the deployment associated with your API key.

GET /api/session?external_session_id=... returns the most recently submitted matching session within the same deployment.

Example Requests

Using the internal session ID:

curl -X GET "https://eu.whitecircle.com/api/session/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2026-04-15"

Using your external session ID:

curl -X GET "https://eu.whitecircle.com/api/session?external_session_id=user-session-123" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2026-04-15"

Response

The endpoint returns the same session envelope as POST /api/session:

session — The session-level verdict, IDs, and policy statuses
artifacts — The artifact result objects for content associated with that session response

If you provided an external_session_id during the original check, you can use it for stable lookups across systems. If you need an exact immutable lookup target, store the returned internal_session_id.

Authorizations

Authorization

string

header

required

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

Headers

whitecircle-version

string

required

API Version

Path Parameters

internal_session_id

string

required

Find a session by its internal session ID

Query Parameters

deployment_id

string

Optional deployment ID to validate session ownership

Response

Success

session

object

required

Hide child attributes

session.flagged

boolean

required

session.internal_session_id

string

required

session.policies

object

required

Hide child attributes

session.policies.{key}

object

Hide child attributes

session.policies.{key}.flagged

boolean

required

session.policies.{key}.flagged_source

enum<string>[]

required

Available options:

text,

image

session.policies.{key}.name

string

required

session.external_session_id

string | null

session.note

string | null

Example:

{
  "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"
    }
  }
}

artifacts

object[]

required

Hide child attributes

artifacts.policies

object

required

Hide child attributes

artifacts.policies.{key}

object

Hide child attributes

artifacts.policies.{key}.flagged

boolean

required

artifacts.policies.{key}.flagged_source

string[]

required

artifacts.policies.{key}.name

string

required

artifacts.kind

string

required

artifacts.status

string

required

artifacts.internal_artifact_id

string

required

artifacts.flagged

boolean | null

artifacts.updated_at

string | null

artifacts.external_artifact_id

string | null

artifacts.external_session_id

string | null

artifacts.internal_session_id

string | null

artifacts.created_at

string | null

artifacts.note

string | null

⌘I

cURL

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

import requests

url = "https://eu.whitecircle.com/api/session/{internal_session_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/{internal_session_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/{internal_session_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/{internal_session_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/{internal_session_id}")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/session/{internal_session_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

{
  "session": {
    "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"
      }
    }
  },
  "artifacts": [
    {
      "flagged": true,
      "policies": {
        "70289e06-9111-463e-b121-7247c2b7bfbd": {
          "flagged": true,
          "flagged_source": [
            "image"
          ],
          "name": "No PII Sharing"
        }
      },
      "kind": "image",
      "status": "completed",
      "updated_at": "2026-04-15T12:00:00Z",
      "internal_artifact_id": "223e4567-e89b-12d3-a456-426614174000",
      "external_artifact_id": "artifact-001",
      "external_session_id": "user-session-001",
      "internal_session_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-04-15T12:00:00Z"
    }
  ]
}

First Steps

Use Cases

Integrations

Sessions

Artifacts

Policy

Metric

User

Route Shapes

Example Requests

Response

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Route Shapes

​Example Requests

​Response

Authorizations

Headers

Path Parameters

Query Parameters

Response

Route Shapes

Example Requests

Response