> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whitecircle.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Artifact Results by ID
> Retrieve artifact check results by internal_artifact_id or external_artifact_id.
Retrieve the results of a previously submitted [artifact check](/2025-12-01/artifact/check-artifact). Use this endpoint to look up artifact policy check results using either the system-generated ID or your custom tracking identifier.
## Query Parameters
| Parameter | Required | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `internal_artifact_id` | ✓\* | System-generated UUID returned in the [artifact check](/2025-12-01/artifact/check-artifact) response. |
| `external_artifact_id` | ✓\* | Your custom tracking ID passed when [checking the artifact](/2025-12-01/artifact/check-artifact). |
| `deployment_id` | | Override deployment resolved from your API key. Defaults to the deployment associated with your API key. |
\*Exactly one of `internal_artifact_id` or `external_artifact_id` is required.
For precise lookups, prefer `internal_artifact_id` over `external_artifact_id`.
When using `external_artifact_id` with multiple matches, the most recently created artifact within the same deployment is returned.
## Example Requests
Using the internal artifact ID:
```bash theme={null}
curl -X GET "https://eu.whitecircle.com/api/artifact/get_by_id?internal_artifact_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
-H "Authorization: Bearer wc-your-api-key" \
-H "whitecircle-version: 2025-12-01"
```
Using your external artifact ID:
```bash theme={null}
curl -X GET "https://eu.whitecircle.com/api/artifact/get_by_id?external_artifact_id=user-avatar-42" \
-H "Authorization: Bearer wc-your-api-key" \
-H "whitecircle-version: 2025-12-01"
```
## Response Overview
| Field | Type | Description |
| ---------------------- | --------------- | -------------------------------------------------------------------------------- |
| `flagged` | boolean \| null | `true` if any policy was violated. `null` while processing or on failure. |
| `policies` | object | Map of policy IDs to their violation statuses |
| `kind` | string | Content type of the artifact (e.g., `"image"`) |
| `status` | string | Check status: `"completed"`, `"processing"`, or `"failed"` |
| `updated_at` | string | ISO 8601 last update timestamp |
| `internal_artifact_id` | string | System-generated UUID for this artifact |
| `external_artifact_id` | string | Your custom artifact tracking ID (if provided) |
| `external_session_id` | string | External ID of the linked session (if attached) |
| `internal_session_id` | string | System-generated UUID of the linked session (if attached) |
| `created_at` | string | ISO 8601 creation timestamp |
| `note` | string | Informational message, included when applicable (e.g. why an image fetch failed) |
Each policy in the `policies` object includes:
* `name` — Human-readable policy name
* `flagged` — Whether this specific policy was violated
* `flagged_source` — Array of content types that triggered the violation (e.g., `["image"]`)
## OpenAPI
````yaml GET /api/artifact/get_by_id
openapi: 3.1.0
info:
title: WhiteCircle API Backend
description: 'Authentication: Bearer API Key Required'
license:
name: ''
version: '2025-12-01'
servers:
- url: https://eu.whitecircle.com
- url: https://us.whitecircle.com
security: []
tags:
- name: Session
description: Session-based content checking and moderation
- name: User
description: User risk assessment and scoring
- name: Policy
description: Policy management CRUD
- name: Metric
description: Metric management CRUD
- name: Artifact
description: Standalone artifact moderation
paths:
/api/artifact/get_by_id:
get:
tags:
- Artifact
summary: Get artifact by ID
description: >-
Retrieve artifact check results by internal_artifact_id or
external_artifact_id.
operationId: artifact_get_by_id
parameters:
- name: whitecircle-version
in: header
description: API Version
required: true
schema:
type: string
example: '2025-12-01'
- name: internal_artifact_id
in: query
required: false
schema:
type:
- string
- 'null'
- name: external_artifact_id
in: query
required: false
schema:
type:
- string
- 'null'
- name: deployment_id
in: query
required: false
schema:
type:
- string
- 'null'
responses:
'200':
description: Artifact found
content:
application/json:
schema:
$ref: '#/components/schemas/ArtifactCheckResponse'
'400':
description: Bad Request
security:
- bearerAuth: []
components:
schemas:
ArtifactCheckResponse:
type: object
required:
- status
- kind
- internal_artifact_id
- policies
properties:
status:
type: string
description: 'Check status: "completed"'
flagged:
type:
- boolean
- 'null'
description: true if any policy was violated
policies:
type: object
additionalProperties:
$ref: '#/components/schemas/ArtifactPolicyStatus'
propertyNames:
type: string
description: Map of policy ID to violation result
internal_artifact_id:
type: string
description: System-generated UUID for this artifact
external_artifact_id:
type:
- string
- 'null'
description: Your custom artifact ID (if provided)
internal_session_id:
type:
- string
- 'null'
description: Internal ID of the linked session (if attached)
external_session_id:
type:
- string
- 'null'
description: External ID of the linked session (if provided)
created_at:
type:
- string
- 'null'
description: ISO 8601 creation timestamp
updated_at:
type:
- string
- 'null'
description: ISO 8601 last update timestamp
kind:
type: string
description: Echo of content.kind from request
note:
type:
- string
- 'null'
description: Informational note (only present when applicable)
description: Artifact check result.
example:
flagged: true
policies:
7eb45909-35a3-4bcb-81b9-049fc7413dba:
name: No Explicit Content
flagged: true
flagged_source:
- image
ad1f958e-e167-4e06-befc-434fd42563c9:
name: No Violence
flagged: false
flagged_source: []
kind: image
status: completed
created_at: '2025-12-01T10:30:00Z'
updated_at: '2025-12-01T10:30:00Z'
internal_artifact_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
external_artifact_id: user-avatar-42
internal_session_id: f47ac10b-58cc-4372-a567-0e02b2c3d479
external_session_id: user-session-123
ArtifactPolicyStatus:
type: object
required:
- flagged
- flagged_source
- name
properties:
flagged:
type: boolean
description: Whether this policy was violated
flagged_source:
type: array
items:
type: string
description: Content types that triggered the violation (e.g., ["image"])
name:
type: string
description: Policy display name
description: Policy violation result for an artifact check.
example:
flagged: true
flagged_source:
- image
name: No Explicit Content
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: API Key
description: 'API Key required. Format: Bearer wc-your-api-key'
````