UGC

★ Only Publicly Available OpenAPI DocumentMediaContent DeliveryapiKey4 EndpointsREST

For Agents

List a Halo 5 player's saved map and game variants and fetch metadata for a single variant by ID.

Connect the UGC to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the UGC, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with UGC API.

List all Halo 5 game variants saved by a specific player

List all Halo 5 map variants saved by a specific player

Fetch metadata for a single Halo 5 game variant by variant ID

Fetch metadata for a single Halo 5 map variant by variant ID

Use Cases

GET STARTED

Start building with UGC API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for UGC, keeping it validated and agent-ready.

The Halo UGC API exposes metadata for user-generated content created by Halo 5: Guardians players, specifically map variants and game variants saved to a player's file share. It returns a list of variants per player and the metadata for any single variant identified by ID. The API is read-only and authenticated with an Ocp-Apim-Subscription-Key issued by the Halo developer portal. Coverage is limited to Halo 5 player-authored content; the binary contents of variants are not returned.

★ Custom Games Discovery Site

Surface a curated catalogue of Halo 5 custom map and game variants for community lobby browsing. The UGC API returns each player's saved variants with names, descriptions, and variant IDs that can be cross-linked to the Halo Stats API for play counts. Coverage is limited to Halo 5 user content.

List all map variants for player gamertag 'AgentSmith' from /h5/players/AgentSmith/mapvariants and display title, description, and variant ID.

Variant Metadata Lookup for Tournaments

Validate tournament map and game variant entries by fetching their metadata from /h5/players/{player}/mapvariants/{variant} and /h5/players/{player}/gamevariants/{variant}. Organisers can confirm a variant's owner and configuration before locking the bracket. Authentication is a single subscription key per organiser.

Fetch the game variant 'tournament-slayer-v3' for player 'OrgAdmin' and verify the gametype and time limit settings.

AI Agent Variant Browser

Let an AI agent answer 'what custom maps does this player have' and 'fetch the description for variant X' through Jentic-managed tools. The agent calls the four UGC endpoints with the subscription key isolated in the Jentic vault and never sees the raw secret. The API only returns metadata, so agents cannot publish or edit variants.

When asked 'show me my map variants', call /h5/players/{player}/mapvariants for the user's gamertag and return the list of variant names with IDs.

Key Endpoints

4 endpoints — the halo ugc api exposes metadata for user-generated content created by halo 5: guardians players, specifically map variants and game variants saved to a player's file share.

METHOD

PATH

DESCRIPTION

GET

/h5/players/{player}/mapvariants

List a player's Halo 5 map variants

GET

/h5/players/{player}/mapvariants/{variant}

Get a single Halo 5 map variant

GET

/h5/players/{player}/gamevariants

List a player's Halo 5 game variants

GET

/h5/players/{player}/gamevariants/{variant}

Get a single Halo 5 game variant

GET

/h5/players/{player}/mapvariants

List a player's Halo 5 map variants

GET

/h5/players/{player}/mapvariants/{variant}

Get a single Halo 5 map variant

GET

/h5/players/{player}/gamevariants

List a player's Halo 5 game variants

GET

/h5/players/{player}/gamevariants/{variant}

Get a single Halo 5 game variant

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Halo subscription keys live in the Jentic vault and are injected as the Ocp-Apim-Subscription-Key header at call time, so raw secrets never enter the agent's prompt or tool-transcript logs.

Intent-based discovery

Agents search Jentic for 'list a halo 5 player's map variants' and Jentic returns GET /h5/players/{player}/mapvariants with its schema directly, skipping the developer portal crawl.

Time to first call

Direct integration: a few hours to provision a subscription key and wire the four endpoints. Through Jentic: under 10 minutes.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Halo Stats

Pair variant metadata with match results to track which custom variants are most played.

Use Halo Stats whenever a question about UGC pivots to play counts, match outcomes, or player service records.

Complementary

Twitch API

Twitch streams and clips alongside Halo custom-game metadata for community showcases.

Use Twitch when the agent needs live stream metadata to pair with a custom variant being played.

Alternative

RAWG Video Games Database

General game metadata when the question is about Halo games as titles, not player-authored variants.

Choose RAWG when the user wants release dates, screenshots, or genre tags for the Halo franchise rather than UGC.

FAQs

Specific to using UGC API through Jentic.

What authentication does the Halo UGC API use?

The Halo UGC API uses an API key in the Ocp-Apim-Subscription-Key header issued by the Halo developer portal. Jentic stores the key in its encrypted vault and injects it on every call so the secret never enters agent prompt logs.

Can I list a Halo 5 player's custom maps with this API?

Yes. Call GET /h5/players/{player}/mapvariants with the player's gamertag to list all map variants saved to their file share, and GET /h5/players/{player}/mapvariants/{variant} to retrieve a single variant's metadata.

What are the rate limits for the Halo UGC API?

Rate limits follow the Halo developer portal subscription tier (typically 10 requests per second on the standard tier) and are shared across all Halo APIs on the same key. Back off on HTTP 429 responses; the API does not return a Retry-After header.

How do I fetch a single Halo 5 game variant through Jentic?

Search Jentic for 'get halo 5 game variant', load the schema for GET /h5/players/{player}/gamevariants/{variant}, and execute with the player and variant IDs. Run pip install jentic and use the async client.search, client.load, and client.execute pattern.

Does the UGC API return the binary contents of map or game variants?

No. The API returns metadata only — variant ID, name, description, owner, and creation timestamps. The binary playable file is not exposed; players still need to download it in-game from the file share.