Scrya

https://www.scrya.com/docs
Admin
Scrya is an in-game advertising platform that uses sophisticated matching pipelines and affinity...
Tokens:38,567
Snippets:254
Trust Score:4.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Make GET Request for Advertiser Revenue

Source: https://www.scrya.com/docs/analytics

Example cURL request to retrieve the total amount spent by the authenticated advertiser.

```bash
curl -s "https://api.scrya.com/api/ads/revenue" \
  -H "Authorization: Bearer sk_live_xxx"
```

--------------------------------

### Get Simulation Options

Source: https://www.scrya.com/docs/api-reference

Retrieves valid mood values, narrative examples, and current affinity configurations for a campaign.

```http
GET /campaigns/{id}/simulate/options
```

```bash
curl https://api.scrya.com/api/ads/campaigns/camp_abc123/simulate/options \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "moods": ["tense", "hopeful", "dramatic", "calm", "chaotic", "mysterious", "humorous", "melancholic"],
  "narrative_examples": [
    "The president addresses the nation from the Oval Office",
    "A secret meeting in the Pentagon basement",
    "Campaign rally in a small Midwestern town",
    "Trade negotiations with foreign diplomats"
  ],
  "current_affinities": [
    {"affinity_type": "lighting", "affinity_value": "warm golden hour", "weight": 1.5},
    {"affinity_type": "mood", "affinity_value": "tense", "weight": 1.2}
  ]
}
```

--------------------------------

### Full Scene Generation Example

Source: https://www.scrya.com/docs/unity

An example coroutine demonstrating the complete workflow: matching an ad, injecting its narrative hook, and recording the impression.

```csharp
public IEnumerator GenerateSceneWithAds(string playerId, string narrative)
{
    AdMatchResponse match = null;

    // 1. Match
    yield return MatchAd(playerId, narrative,
        new[] { "tense", "urgent" },
        (m) => match = m);

    // 2. Inject
    if (match != null)
    {
        dialogueSystem.AddLine(match.narrative_hook);
        Debug.Log($"Ad from {match.brand_name}: {match.narrative_hook}");
    }

    // ... render the scene ...

    // 3. Record (after player sees it)
    yield return RecordImpression(match);
}
```

--------------------------------

### Make GET Request for Campaign Pacing Analytics

Source: https://www.scrya.com/docs/analytics

Example cURL request to fetch budget pacing information for a specific campaign.

```bash
curl -s "https://api.scrya.com/api/ads/campaigns/camp_abc123/analytics/pacing" \
  -H "Authorization: Bearer sk_live_xxx"
```

--------------------------------

### Geo-Targeting Response Example

Source: https://www.scrya.com/docs/api-reference

Example JSON response returned after successfully creating a geo-target.

```json
{
  "id": "geo_xyz789",
  "campaign_id": "camp_abc123",
  "target_type": "country",
  "country_code": "US",
  "include": true,
  "created_at": "2026-03-01T12:00:00Z"
}
```

--------------------------------

### Make GET Request for Creator Revenue

Source: https://www.scrya.com/docs/analytics

Example cURL request to fetch the total earnings for the authenticated game developer.

```bash
curl -s "https://api.scrya.com/api/ads/creator-revenue" \
  -H "Authorization: Bearer sk_live_xxx"
```

--------------------------------

### Make GET Request for Per-Game Earnings

Source: https://www.scrya.com/docs/analytics

Example cURL request to retrieve earnings for a specific game using its ID.

```bash
curl -s "https://api.scrya.com/api/ads/creator-revenue/my_game_id" \
  -H "Authorization: Bearer sk_live_xxx"
```

--------------------------------

### Blocklist Rule Response Example

Source: https://www.scrya.com/docs/api-reference

Example JSON response returned after successfully creating a blocklist rule.

```json
{
  "id": "blk_abc789",
  "campaign_id": "camp_abc123",
  "rule_type": "keyword",
  "value": "violence",
  "created_at": "2026-03-01T12:00:00Z"
}
```

--------------------------------

### Documentary Streaming Service Affinity Example

Source: https://www.scrya.com/docs/affinities

Example affinity configuration for a documentary streaming service, highlighting natural lighting, documentary-style effects, and a contemplative mood.

```json
{
  "affinities": [
    { "affinity_type": "lighting",  "affinity_value": "natural",      "weight": 2.0 },
    { "affinity_type": "effects",   "affinity_value": "documentary",  "weight": 2.5 },
    { "affinity_type": "mood",      "affinity_value": "contemplative", "weight": 1.5 },
    { "affinity_type": "action",    "affinity_value": "revelation",   "weight": 2.0 },
    { "affinity_type": "category",  "affinity_value": "simulation",   "weight": 1.0 }
  ]
}
```

--------------------------------

### GET /campaigns/{id}/simulate/options

Source: https://www.scrya.com/docs/api-reference

Retrieve available options for the simulation endpoint, including valid mood values, narrative function examples, and the campaign's current affinity configuration.

```APIDOC
## GET /campaigns/{id}/simulate/options

### Description
Get available options for the simulation endpoint, including valid mood values, narrative function examples, and the campaign's current affinity configuration.

### Method
GET

### Endpoint
/campaigns/{id}/simulate/options

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the campaign for which to get simulation options.

### Request Example
```bash
curl https://api.scrya.com/api/ads/campaigns/camp_abc123/simulate/options \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **moods** (array) - A list of valid mood values for simulation.
- **narrative_examples** (array) - Example narrative functions for simulation.
- **current_affinities** (array) - The campaign's current affinity configuration.
  - **affinity_type** (string) - The type of affinity (e.g., "lighting", "mood").
  - **affinity_value** (string) - The value of the affinity.
  - **weight** (number) - The weight of this affinity.

#### Response Example
```json
{
  "moods": ["tense", "hopeful", "dramatic", "calm", "chaotic", "mysterious", "humorous", "melancholic"],
  "narrative_examples": [
    "The president addresses the nation from the Oval Office",
    "A secret meeting in the Pentagon basement",
    "Campaign rally in a small Midwestern town",
    "Trade negotiations with foreign diplomats"
  ],
  "current_affinities": [
    {"affinity_type": "lighting", "affinity_value": "warm golden hour", "weight": 1.5},
    {"affinity_type": "mood", "affinity_value": "tense", "weight": 1.2}
  ]
}
```
```

--------------------------------

### Cyberpunk Game Studio Affinity Example

Source: https://www.scrya.com/docs/affinities

Example affinity configuration for a cyberpunk game studio, emphasizing neon aesthetics, noir effects, and a paranoid mood.

```json
{
  "affinities": [
    { "affinity_type": "lighting",  "affinity_value": "neon",       "weight": 3.0 },
    { "affinity_type": "effects",   "affinity_value": "noir",       "weight": 2.0 },
    { "affinity_type": "location",  "affinity_value": "neon-lit alley", "weight": 2.0 },
    { "affinity_type": "mood",      "affinity_value": "paranoid",   "weight": 1.5 },
    { "affinity_type": "action",    "affinity_value": "confrontation", "weight": 1.0 }
  ]
}
```

--------------------------------

### Apply Visual Bias Example

Source: https://www.scrya.com/docs/unity

Demonstrates how to apply visual bias (lighting, effects) to the scene based on the matched ad's properties. This code should be placed after a successful ad match.

```csharp
// After getting a match:
if (match != null)
{
    // Inject narrative hook into dialogue
    dialogueSystem.AddLine(match.narrative_hook);

    // Optionally simulate to get visual bias
    StartCoroutine(SimulateBias(match.campaign_id, "crisis", "tense, kinetic",
        (sim) =>
        {
            // Apply biased lighting
            if (!string.IsNullOrEmpty(sim.biased_lighting))
                sceneLighting.SetPreset(sim.biased_lighting);

            // Apply biased effects
            if (!string.IsNullOrEmpty(sim.biased_effects))
                postProcessing.SetPreset(sim.biased_effects);
        }));
}
```

--------------------------------

### Get Placement Configuration

Source: https://www.scrya.com/docs/api-reference

Retrieves the current ad placement settings for a registered game.

```http
GET /placements/{game_id}
```

```bash
curl https://api.scrya.com/api/ads/placements/my_game_id \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Rate Limit Headers

Source: https://www.scrya.com/docs/api-reference

Example of rate limit headers returned in API responses.

```http
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 997
X-RateLimit-Reset: 1709294460
```

--------------------------------

### Initialize Scrya API Client

Source: https://www.scrya.com/docs/web

Provides helper functions for POST and GET requests to the Scrya API using the Fetch API.

```javascript
// scrya.js — minimal client
const SCRYA_API = 'https://api.scrya.com/api/ads';
const API_KEY = 'sk_live_your_key_here';

async function scryaPost(endpoint, body) {
  const res = await fetch(SCRYA_API + endpoint, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer ' + API_KEY,
    },
    body: JSON.stringify(body),
  });

  if (res.status === 204) return null; // No ad matched
  if (!res.ok) throw new Error('Scrya API error: ' + res.status);
  return res.json();
}

async function scryaGet(endpoint) {
  const res = await fetch(SCRYA_API + endpoint, {
    headers: { 'Authorization': 'Bearer ' + API_KEY },
  });
  if (!res.ok) throw new Error('Scrya API error: ' + res.status);
  return res.json();
}
```

--------------------------------

### Luxury Watch Brand Affinity Example

Source: https://www.scrya.com/docs/affinities

Example affinity configuration for a luxury watch brand, focusing on warm lighting, cinematic effects, and premium locations.

```json
{
  "affinities": [
    { "affinity_type": "lighting",  "affinity_value": "warm",      "weight": 2.5 },
    { "affinity_type": "effects",   "affinity_value": "cinematic", "weight": 2.0 },
    { "affinity_type": "location",  "affinity_value": "rooftop terrace", "weight": 1.5 },
    { "affinity_type": "mood",      "affinity_value": "triumphant", "weight": 1.5 },
    { "affinity_type": "action",    "affinity_value": "celebration", "weight": 1.0 }
  ]
}
```

--------------------------------

### Advertiser Registration Response (201)

Source: https://www.scrya.com/docs/api-reference

Example of a successful advertiser registration response, including the advertiser's ID, profile information, and initial balance.

```json
{
  "id": "adv_abc123",
  "company_name": "Acme Corp",
  "contact_email": "ads@acme.com",
  "website": "https://acme.com",
  "balance_cents": 0,
  "created_at": "2026-03-01T12:00:00Z"
}
```

--------------------------------

### Campaign Scoring Examples

Source: https://www.scrya.com/docs/matching

Calculations demonstrating how affinity and priority can allow a lower-bid campaign to outperform a higher-bid competitor.

```text
base_cpm         = 200
category_affinity = 1.5   (category affinity matches game category)
priority_boost   = 1.0 + (3 × 0.1) = 1.3
affinity_match   = 1.0 + ((1.5 + 2.0) / 3) = 1.0 + 1.167 = 2.167

Score = 200 × 1.5 × 1.3 × 2.167 = 845.1
```

```text
Score = 300 × 1.0 × 1.0 × 1.0 = 300
```

--------------------------------

### Get Campaign Detail

Source: https://www.scrya.com/docs/api-reference

Fetches comprehensive details for a specific campaign by ID.

```http
GET /campaigns/{id}
```

```bash
curl https://api.scrya.com/api/ads/campaigns/camp_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### GET /profile

Source: https://www.scrya.com/docs/api-reference

Retrieves the authenticated advertiser's profile information.

```APIDOC
## GET /profile

### Description
Retrieve the authenticated advertiser's profile, including current balance.

### Method
GET

### Endpoint
/profile

### Response
#### Success Response (200)
- **id** (string) - Advertiser ID
- **company_name** (string) - Company name
- **contact_email** (string) - Contact email
- **website** (string) - Website URL
- **balance_cents** (integer) - Current balance in cents
- **created_at** (string) - ISO timestamp of creation

#### Response Example
{
  "id": "adv_abc123",
  "company_name": "Acme Corp",
  "contact_email": "ads@acme.com",
  "website": "https://acme.com",
  "balance_cents": 500000,
  "created_at": "2026-03-01T12:00:00Z"
}
```

--------------------------------

### Get Campaign Budget Pacing

Source: https://www.scrya.com/docs/api-reference

Retrieves budget utilization, spend rates, and projected exhaustion dates.

```http
GET /campaigns/{id}/analytics/pacing
```

```bash
curl https://api.scrya.com/api/ads/campaigns/camp_abc123/analytics/pacing \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "campaign_id": "camp_abc123",
  "budget_cents": 500000,
  "spent_cents": 38075,
  "remaining_cents": 461925,
  "daily_cap_cents": 25000,
  "today_spent_cents": 12400,
  "today_remaining_cents": 12600,
  "avg_daily_spend_cents": 5439,
  "projected_exhaustion_date": "2026-05-25",
  "days_remaining": 85,
  "pacing_status": "under_pacing",
  "utilization_pct": 49.6
}
```

--------------------------------

### Get Per-Game Earnings

Source: https://www.scrya.com/docs/api-reference

Retrieves detailed earnings and performance metrics for a specific game.

```http
GET /creator-revenue/{game_id}
```

```bash
curl https://api.scrya.com/api/ads/creator-revenue/my_game_id \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "game_id": "my_game_id",
  "earned_cents": 85000,
  "impressions": 48500,
  "revenue_share_pct": 70,
  "top_advertisers": [
    {"advertiser_id": "adv_abc123", "impressions": 15230, "earned_cents": 26653},
    {"advertiser_id": "adv_xyz456", "impressions": 12100, "earned_cents": 21175}
  ],
  "daily": [
    {"date": "2026-02-28", "impressions": 2150, "earned_cents": 3763},
    {"date": "2026-02-27", "impressions": 1980, "earned_cents": 3465}
  ]
}
```

--------------------------------

### GET /creator-revenue/{game_id}

Source: https://www.scrya.com/docs/api-reference

Retrieve detailed earnings for a specific game, including top advertisers and daily earnings.

```APIDOC
## GET /creator-revenue/{game_id}

### Description
Get detailed earnings for a specific game.

### Method
GET

### Endpoint
/creator-revenue/{game_id}

### Parameters
#### Path Parameters
- **game_id** (string) - Required - The ID of the game for which to retrieve earnings.

### Request Example
```bash
curl https://api.scrya.com/api/ads/creator-revenue/my_game_id \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **game_id** (string) - Unique identifier for the game.
- **earned_cents** (integer) - Earnings for this game in cents.
- **impressions** (integer) - Impressions for this game.
- **revenue_share_pct** (number) - Revenue share percentage for this game.
- **top_advertisers** (array) - List of top advertisers and their performance.
  - **advertiser_id** (string) - Unique identifier for the advertiser.
  - **impressions** (integer) - Impressions from this advertiser.
  - **earned_cents** (integer) - Earnings from this advertiser in cents.
- **daily** (array) - Daily earnings breakdown.
  - **date** (string) - The date of the earnings record (YYYY-MM-DD).
  - **impressions** (integer) - Impressions for this date.
  - **earned_cents** (integer) - Earnings for this date in cents.

#### Response Example
```json
{
  "game_id": "my_game_id",
  "earned_cents": 85000,
  "impressions": 48500,
  "revenue_share_pct": 70,
  "top_advertisers": [
    {"advertiser_id": "adv_abc123", "impressions": 15230, "earned_cents": 26653},
    {"advertiser_id": "adv_xyz456", "impressions": 12100, "earned_cents": 21175}
  ],
  "daily": [
    {"date": "2026-02-28", "impressions": 2150, "earned_cents": 3763},
    {"date": "2026-02-27", "impressions": 1980, "earned_cents": 3465}
  ]
}
```
```

--------------------------------

### Deposit Ad Spend Response (200)

Source: https://www.scrya.com/docs/api-reference

Example of a successful response after depositing ad spend. Shows the updated balance and the amount that was just deposited.

```json
{
  "balance_cents": 600000,
  "deposited_cents": 100000
}
```

--------------------------------

### Advertiser Profile Response (200)

Source: https://www.scrya.com/docs/api-reference

Example of a successful response when retrieving an advertiser's profile. Shows company details, contact information, and ad spend balance.

```json
{
  "id": "adv_abc123",
  "company_name": "Acme Corp",
  "contact_email": "ads@acme.com",
  "website": "https://acme.com",
  "balance_cents": 500000,
  "created_at": "2026-03-01T12:00:00Z"
}
```

--------------------------------

### Get Campaign Analytics Pacing

Source: https://www.scrya.com/docs/analytics

Retrieves budget pacing information for a campaign. Use the `on_track` flag and spend ratios to adjust CPM bids.

```json
[
  {
    "affinity_type": "lighting",
    "affinity_value": "warm",
    "weight": 2.0,
    "matched_impressions": 1847
  },
  {
    "affinity_type": "effects",
    "affinity_value": "cinematic",
    "weight": 1.5,
    "matched_impressions": 1623
  },
  {
    "affinity_type": "category",
    "affinity_value": "simulation",
    "weight": 1.0,
    "matched_impressions": 1204
  },
  {
    "affinity_type": "mood",
    "affinity_value": "triumphant",
    "weight": 1.5,
    "matched_impressions": 487
  },
  {
    "affinity_type": "action",
    "affinity_value": "celebration",
    "weight": 1.0,
    "matched_impressions": 312
  },
  {
    "affinity_type": "location",
    "affinity_value": "rooftop terrace",
    "weight": 1.0,
    "matched_impressions": 89
  }
]
```

```json
{
  "daily_cap_cents": 15000,
  "avg_daily_spend_cents": 12740,
  "days_elapsed": 14,
  "days_remaining": 16,
  "projected_total_spend_cents": 382200,
  "on_track": true
}
```

--------------------------------

### Get Advertiser Profile with cURL

Source: https://www.scrya.com/docs/api-reference

Use this cURL command to retrieve the authenticated advertiser's profile information, including their current balance.

```curl
curl https://api.scrya.com/api/ads/profile \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Enable Ad Placements

Source: https://www.scrya.com/docs/quickstart

Register your game's ad acceptance settings via a POST request.

```bash
curl -X POST https://api.scrya.com/api/ads/placements/my_game_id \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "creator_id": "your_user_id",
    "placement_types": ["narrative_hook"],
    "revenue_share_pct": 70,
    "max_ads_per_session": 5
  }'
```

--------------------------------

### POST /campaigns/{id}/simulate

Source: https://www.scrya.com/docs/api-reference

Preview how a campaign's affinities would bias the rendering pipeline for a given scene context. Useful for testing and tuning affinities before activating a campaign.

```APIDOC
## POST /campaigns/{id}/simulate

### Description
Preview the pipeline bias your campaign would produce for a given narrative context.

### Method
POST

### Endpoint
/campaigns/{id}/simulate

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the campaign to simulate.

#### Request Body
- **narrative_function** (string) - Optional - Scene narrative context (e.g., "The president reviews classified documents").
- **mood** (string) - Optional - Scene mood (e.g., "tense", "hopeful", "dramatic").

### Request Example
```bash
curl -X POST https://api.scrya.com/api/ads/campaigns/camp_abc123/simulate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "narrative_function": "The president reviews classified documents in the Oval Office",
    "mood": "tense"
  }'
```

### Response
#### Success Response (200)
- **campaign_id** (string) - The ID of the campaign.
- **matched_creative** (object) - Details of the creative matched for the simulation.
  - **id** (string) - The ID of the matched creative.
  - **narrative_hook** (string) - A narrative hook associated with the creative.
  - **creative_type** (string) - The type of the creative.
- **biased_pipeline** (object) - The resulting biased rendering pipeline parameters.
  - **lighting** (string) - Recommended lighting.
  - **effects** (string) - Recommended visual effects.
  - **camera** (string) - Recommended camera settings.
  - **mood** (string) - The resulting mood.
- **affinity_scores** (object) - Scores for different affinity types.
  - **lighting** (number) - Affinity score for lighting.
  - **mood** (number) - Affinity score for mood.
  - **camera** (number) - Affinity score for camera.
  - **effects** (number) - Affinity score for effects.
- **total_score** (number) - Overall simulation score.

#### Response Example
```json
{
  "campaign_id": "camp_abc123",
  "matched_creative": {
    "id": "crt_def456",
    "narrative_hook": "A familiar logo on the briefing folder catches your eye — Acme Shield, the defense contractor everyone in Washington seems to know.",
    "creative_type": "narrative_hook"
  },
  "biased_pipeline": {
    "lighting": "warm golden hour",
    "effects": "film grain, cinematic widescreen",
    "camera": "close-up",
    "mood": "tense"
  },
  "affinity_scores": {
    "lighting": 0.63,
    "mood": 0.82,
    "camera": 0.24,
    "effects": 0.41
  },
  "total_score": 0.73
}
```
```

--------------------------------

### Enable Game Placements

Source: https://www.scrya.com/docs/api-reference

Registers a game for ad serving with specific configuration parameters.

```http
POST /placements/{game_id}
```

```bash
curl -X POST https://api.scrya.com/api/ads/placements/my_game_id \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "creator_id": "dev_user_123",
    "placement_types": ["narrative_hook", "product_mention"],
    "revenue_share_pct": 70,
    "max_ads_per_session": 5,
    "blocked_categories": ["gambling"]
  }'
```

```json
{
  "game_id": "my_game_id",
  "creator_id": "dev_user_123",
  "placement_types": ["narrative_hook", "product_mention"],
  "revenue_share_pct": 70,
  "max_ads_per_session": 5,
  "blocked_advertisers": [],
  "blocked_categories": ["gambling"],
  "is_active": true,
  "created_at": "2026-03-01T12:00:00Z"
}
```

--------------------------------

### Create Campaign

Source: https://www.scrya.com/docs/api-reference

Initializes a new campaign in draft status. Requires specific budget and bid parameters.

```http
POST /campaigns
```

```bash
curl -X POST https://api.scrya.com/api/ads/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer 2026 Launch",
    "budget_cents": 500000,
    "cpm_bid_cents": 250,
    "daily_cap_cents": 25000,
    "start_date": "2026-06-01T00:00:00Z",
    "end_date": "2026-08-31T23:59:59Z",
    "priority": 7,
    "target_categories": ["simulation", "strategy"],
    "target_tags": ["political"]
  }'
```

```json
{
  "id": "camp_abc123",
  "name": "Summer 2026 Launch",
  "status": "draft",
  "budget_cents": 500000,
  "spent_cents": 0,
  "cpm_bid_cents": 250,
  "daily_cap_cents": 25000,
  "start_date": "2026-06-01T00:00:00Z",
  "end_date": "2026-08-31T23:59:59Z",
  "priority": 7,
  "target_categories": ["simulation", "strategy"],
  "target_tags": ["political"],
  "created_at": "2026-03-01T12:00:00Z"
}
```

--------------------------------

### Add HTTP and Json Modules to Build.cs

Source: https://www.scrya.com/docs/unreal

Ensure your project's Build.cs file includes the HTTP and Json modules for network requests and JSON handling.

```csharp
// YourGame.Build.cs
PublicDependencyModuleNames.AddRange(new string[] {
    "Core", "CoreUObject", "Engine", "HTTP", "Json", "JsonUtilities"
});
```

--------------------------------

### GET /revenue

Source: https://www.scrya.com/docs/api-reference

Retrieve a summary of total ad spend for the authenticated advertiser across all their campaigns.

```APIDOC
## GET /revenue

### Description
Get total spend summary for the authenticated advertiser across all campaigns.

### Method
GET

### Endpoint
/revenue

### Request Example
```bash
curl https://api.scrya.com/api/ads/revenue \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **total_spent_cents** (integer) - Total amount spent in cents.
- **total_impressions** (integer) - Total number of impressions.
- **active_campaigns** (integer) - Number of currently active campaigns.
- **balance_cents** (integer) - Current account balance in cents.
- **campaigns** (array) - List of campaign spending summaries.
  - **campaign_id** (string) - Unique identifier for the campaign.
  - **name** (string) - Name of the campaign.
  - **spent_cents** (integer) - Amount spent on this campaign in cents.
  - **impressions** (integer) - Number of impressions for this campaign.
  - **status** (string) - Status of the campaign (e.g., "active").

#### Response Example
```json
{
  "total_spent_cents": 152300,
  "total_impressions": 60920,
  "active_campaigns": 3,
  "balance_cents": 347700,
  "campaigns": [
    {
      "campaign_id": "camp_abc123",
      "name": "Summer 2026 Launch",
      "spent_cents": 38075,
      "impressions": 15230,
      "status": "active"
    }
  ]
}
```
```

--------------------------------

### Get Creator Total Earnings

Source: https://www.scrya.com/docs/api-reference

Retrieves total earnings across all games for an authenticated developer.

```http
GET /creator-revenue
```

```bash
curl https://api.scrya.com/api/ads/creator-revenue \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "total_earned_cents": 106610,
  "total_impressions": 60920,
  "games_count": 2,
  "games": [
    {
      "game_id": "my_game_id",
      "earned_cents": 85000,
      "impressions": 48500,
      "revenue_share_pct": 70
    },
    {
      "game_id": "my_other_game",
      "earned_cents": 21610,
      "impressions": 12420,
      "revenue_share_pct": 70
    }
  ]
}
```

--------------------------------

### Get Campaign Geographic Analytics

Source: https://www.scrya.com/docs/api-reference

Retrieves performance metrics broken down by country for a specific campaign.

```http
GET /campaigns/{id}/analytics/geo
```

```bash
curl https://api.scrya.com/api/ads/campaigns/camp_abc123/analytics/geo \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "campaign_id": "camp_abc123",
  "countries": [
    {
      "country_code": "US",
      "impressions": 10500,
      "unique_users": 5800,
      "spent_cents": 26250
    },
    {
      "country_code": "GB",
      "impressions": 2100,
      "unique_users": 1150,
      "spent_cents": 5250
    },
    {
      "country_code": "DE",
      "impressions": 1430,
      "unique_users": 780,
      "spent_cents": 3575
    }
  ]
}
```

--------------------------------

### Match Ad Functionality

Source: https://www.scrya.com/docs/unity

Initiates an ad matching request with specified player and game context. Handles the response or logs an error if no ad matches.

```csharp
public IEnumerator MatchAd(string playerId, string narrative, string[] moods,
    System.Action<AdMatchResponse> callback)
{
    var request = new AdMatchRequest
    {
        game_id = gameId,
        user_id = playerId,
        player_geo = new PlayerGeo { country_code = "US" },
        game_context = new GameContext
        {
            theme_id = "3",
            category = "simulation",
            narrative = narrative,
            mood_tags = moods
        },
        session_id = System.Guid.NewGuid().ToString()
    };

    yield return PostJson("/match", JsonUtility.ToJson(request), (json) =>
    {
        var match = JsonUtility.FromJson<AdMatchResponse>(json);
        callback?.Invoke(match);
    }, (error) =>
    {
        Debug.Log("No ad matched (normal): " + error);
        callback?.Invoke(null);
    });
}
```

--------------------------------

### Get Advertiser Spend Summary

Source: https://www.scrya.com/docs/api-reference

Retrieves total spend and campaign performance metrics for an authenticated advertiser.

```http
GET /revenue
```

```bash
curl https://api.scrya.com/api/ads/revenue \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "total_spent_cents": 152300,
  "total_impressions": 60920,
  "active_campaigns": 3,
  "balance_cents": 347700,
  "campaigns": [
    {
      "campaign_id": "camp_abc123",
      "name": "Summer 2026 Launch",
      "spent_cents": 38075,
      "impressions": 15230,
      "status": "active"
    }
  ]
}
```

--------------------------------

### Async Ad Matching with HttpClient

Source: https://www.scrya.com/docs/unity

Use this method for asynchronous ad matching in Unity 2023+ or with UniTask. It requires an API key for authorization and handles HTTP POST requests to the matching endpoint.

```csharp
public async Task<AdMatchResponse> MatchAdAsync(string playerId, string narrative)
{
    using var client = new HttpClient();
    client.DefaultRequestHeaders.Add("Authorization", "Bearer " + apiKey);

    var json = JsonUtility.ToJson(new AdMatchRequest { /* ... */ });
    var content = new StringContent(json, Encoding.UTF8, "application/json");

    var response = await client.PostAsync(API_BASE + "/match", content);

    if (response.StatusCode == System.Net.HttpStatusCode.NoContent)
        return null; // No matching ads

    var responseJson = await response.Content.ReadAsStringAsync();
    return JsonUtility.FromJson<AdMatchResponse>(responseJson);
}
```

--------------------------------

### ScryaAds C++ Implementation File

Source: https://www.scrya.com/docs/unreal

Implements the FScryaAds class, initializing API constants and providing the PostJson method to handle HTTP POST requests with JSON bodies and custom callbacks.

```cpp
// ScryaAds.cpp
#include "ScryaAds.h"

const FString FScryaAds::ApiBase = TEXT("https://api.scrya.com/api/ads");
FString FScryaAds::ApiKey = TEXT("sk_live_your_key_here");
FString FScryaAds::GameId = TEXT("your_game_id");

void FScryaAds::PostJson(const FString& Endpoint, const FString& JsonBody,
    TFunction<void(FHttpResponsePtr, bool)> Callback)
{
    auto Request = FHttpModule::Get().CreateRequest();
    Request->SetURL(ApiBase + Endpoint);
    Request->SetVerb(TEXT("POST"));
    Request->SetHeader(TEXT("Content-Type"), TEXT("application/json"));
    Request->SetHeader(TEXT("Authorization"), TEXT("Bearer ") + ApiKey);
    Request->SetContentAsString(JsonBody);

    Request->OnProcessRequestComplete().BindLambda(
        [Callback](FHttpRequestPtr Req, FHttpResponsePtr Resp, bool bSuccess)
        {
            Callback(Resp, bSuccess && Resp.IsValid() && Resp->GetResponseCode() == 200);
        });

    Request->ProcessRequest();
}
```

--------------------------------

### Get Campaign Affinity Effectiveness

Source: https://www.scrya.com/docs/api-reference

Retrieves performance data for ad affinities, including match rates and score contributions.

```http
GET /campaigns/{id}/analytics/affinities
```

```bash
curl https://api.scrya.com/api/ads/campaigns/camp_abc123/analytics/affinities \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "campaign_id": "camp_abc123",
  "affinities": [
    {
      "affinity_id": "aff_lmn456",
      "affinity_type": "lighting",
      "affinity_value": "warm golden hour",
      "weight": 1.5,
      "match_rate": 0.42,
      "avg_score_contribution": 0.31,
      "impressions_influenced": 6397
    },
    {
      "affinity_id": "aff_opq789",
      "affinity_type": "mood",
      "affinity_value": "tense",
      "weight": 1.2,
      "match_rate": 0.68,
      "avg_score_contribution": 0.22,
      "impressions_influenced": 10356
    }
  ]
}
```

--------------------------------

### List Blocklist Rules

Source: https://www.scrya.com/docs/api-reference

Retrieves all blocklist rules configured for a campaign.

```text
GET /campaigns/{id}/blocklist
```

```bash
curl https://api.scrya.com/api/ads/campaigns/camp_abc123/blocklist \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Get Campaign Detail API

Source: https://www.scrya.com/docs/api-reference

Fetches the complete details for a specific campaign, including its current status and accumulated spend.

```APIDOC
## GET /campaigns/{id}

### Description
Get full details for a single campaign, including spend totals and status.

### Method
GET

### Endpoint
/campaigns/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the campaign.

### Response
#### Success Response (200)
Full campaign object.

### Request Example
```curl
curl https://api.scrya.com/api/ads/campaigns/camp_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"
```
```

--------------------------------

### Register Advertiser with cURL

Source: https://www.scrya.com/docs/api-reference

Use this cURL command to register a new advertiser account. Requires company name, contact email, and optionally a website. The response includes the new advertiser's ID and profile details.

```curl
curl -X POST https://api.scrya.com/api/ads/register \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ 
    "company_name": "Acme Corp",
    "contact_email": "ads@acme.com",
    "website": "https://acme.com"
  }'
```

--------------------------------

### POST /match

Source: https://www.scrya.com/docs/api-reference

Find the best matching ad for a given game context. The matching pipeline evaluates all active campaigns against the provided context, applying geo targeting, blocklist rules, affinity scoring, and budget constraints. Returns the winning creative with pipeline bias values, or `204 No Content` if no ads match.

```APIDOC
## POST /match

### Description
Find the best matching ad for a given game context. The matching pipeline evaluates all active campaigns against the provided context, applying geo targeting, blocklist rules, affinity scoring, and budget constraints. Returns the winning creative with pipeline bias values, or `204 No Content` if no ads match.

### Method
POST

### Endpoint
/match

### Parameters
#### Request Body
- **game_id** (string) - Required - Your registered game ID
- **user_id** (string) - Required - Current player's user ID (for frequency capping)
- **player_geo** (object) - Optional - Player geographic data
  - **country_code** (string) - ISO 3166-1 alpha-2 code
  - **state_code** (string) - State/province code
  - **city_name** (string) - City name
  - **lat** (number) - Latitude
  - **lng** (number) - Longitude
- **game_context** (object) - Required - Current scene context
  - **theme_id** (string) - Active game theme
  - **category** (string) - Game category
  - **narrative** (string) - Current narrative text or scene description
  - **mood_tags** (array of strings) - Current mood tags
  - **location** (string) - Current game location
  - **actions** (array of strings) - Available player actions
- **session_id** (string) - Optional - Game session ID (for per-session frequency capping)

### Request Example
```json
{
  "game_id": "my_game_id",
  "user_id": "player_123",
  "player_geo": {
    "country_code": "US",
    "state_code": "CA"
  },
  "game_context": {
    "theme_id": "1",
    "category": "simulation",
    "narrative": "The president faces a difficult decision about defense spending",
    "mood_tags": ["tense", "dramatic"],
    "location": "oval_office",
    "actions": ["approve_budget", "reject_budget", "defer"]
  },
  "session_id": "sess_abc"
}
```

### Response
#### Success Response (200)
- **campaign_id** (string) - Description
- **creative_id** (string) - Description
- **narrative_hook** (string) - Description
- **creative_type** (string) - Description
- **brand_name** (string) - Description
- **product_name** (string) - Description
- **tagline** (string) - Description
- **tone** (string) - Description
- **biased_pipeline** (object) - Description
  - **lighting** (string) - Description
  - **effects** (string) - Description
  - **camera** (string) - Description
  - **mood** (string) - Description
- **affinity_score** (number) - Description
- **cpm_bid_cents** (number) - Description

#### Success Response (204)
No content. No matching ads found — proceed with normal scene generation.

#### Response Example (200)
```json
{
  "campaign_id": "camp_abc123",
  "creative_id": "crt_def456",
  "narrative_hook": "A familiar logo on the briefing folder catches your eye — Acme Shield, the defense contractor everyone in Washington seems to know.",
  "creative_type": "narrative_hook",
  "brand_name": "Acme Corp",
  "product_name": "Acme Shield",
  "tagline": "Protection you can trust",
  "tone": "neutral",
  "biased_pipeline": {
    "lighting": "warm golden hour",
    "effects": "film grain, cinematic widescreen",
    "camera": "close-up",
    "mood": "tense"
  },
  "affinity_score": 0.73,
  "cpm_bid_cents": 250
}
```
```

--------------------------------

### Sparse Geometric Product in Cl(3,0)

Source: https://www.scrya.com/rotorquant

This C++ code demonstrates the sparse geometric product for a rotor multiplied by a multivector in Cl(3,0). It uses 28 Fused Multiply-Add operations compared to 64 for a full geometric product, optimizing performance for rotor operations.

```cpp
// Sparse GP: rotor * multivector (28 FMAs vs 64 for full)
r[0] = s*x[0] - p12*x[4] - p13*x[5] - p23*x[6];
r[1] = s*x[1] + p12*x[2] + p13*x[3] + p23*x[7];
r[2] = s*x[2] - p12*x[1] + p23*x[3] - p13*x[7];
r[3] = s*x[3] - p13*x[1] - p23*x[2] + p12*x[7];
r[4] = s*x[4] + p12*x[0];
r[5] = s*x[5] + p13*x[0];
r[6] = s*x[6] + p23*x[0];
r[7] = s*x[7] - p23*x[1] + p13*x[2] - p12*x[3];
```

--------------------------------

### Get Per-Creative Campaign Analytics

Source: https://www.scrya.com/docs/api-reference

Retrieve campaign performance data broken down by individual creative. This provides insights into which creatives are performing best.

```HTTP
GET /campaigns/{id}/analytics/creatives
```

```curl
curl https://api.scrya.com/api/ads/campaigns/camp_abc123/analytics/creatives \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```JSON
{
  "campaign_id": "camp_abc123",
  "creatives": [
    {
      "creative_id": "crt_def456",
      "creative_type": "narrative_hook",
      "brand_name": "Acme Corp",
      "impressions": 9500,
      "unique_users": 5200,
      "spent_cents": 23750,
      "avg_affinity_score": 0.78
    },
    {
      "creative_id": "crt_ghi789",
      "creative_type": "product_mention",
      "brand_name": "Acme Corp",
      "impressions": 5730,
      "unique_users": 3221,
      "spent_cents": 14325,
      "avg_affinity_score": 0.65
    }
  ]
}
```
Tokens:
Raw