canonical: https://jentic.com/apis/xapi.us/xapi-us

# XAPI Xbox API

XAPI provides access to Xbox Live data including profiles, achievements, game clips, screenshots, friends, clubs, and marketplace information. The API exposes 34 endpoints secured with bearer authentication.

## For AI agents

Programmatically retrieve authenticated user profile, get profile for specified xuid. Covers 34 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for social media only.

## Capabilities

- Retrieve authenticated user profile
- Get profile for specified XUID
- Check presence information
- List all conversations
- Monitor XAPI Xbox API operational status and events

## Use cases

### Social Media Operations

Use the XAPI Xbox API to perform social media operations programmatically. The API provides 34 endpoints covering core functionality including retrieve authenticated user profile, get profile for specified xuid, get profile by gamertag.

Example prompt: Call GET `/api/profile` to retrieve authenticated user profile

### Automated Achievements Management

Automate achievements operations by combining multiple XAPI Xbox API endpoints. Agents can get profile for specified xuid and then get profile by gamertag in a single workflow.

Example prompt: Call GET `/api/{xuid}/profile` to get profile for specified xuid, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call XAPI Xbox API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'retrieve authenticated user profile', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/profile` | Retrieve authenticated user profile |
| GET | `/api/{xuid}/profile` | Get profile for specified XUID |
| GET | `/api/{gamertag}/profile-for-gamertag` | Get profile by gamertag |
| GET | `/api/{xuid}/gamercard` | Retrieve Xbox 360 gamercard |
| GET | `/api/{xuid}/presence` | Check presence information |
| GET | `/api/{xuid}/activity` | Get current activity status |
| GET | `/api/conversations` | List all conversations |
| GET | `/api/conversations/{xuid}` | Get conversation with another user |

## Key resources

- **Achievements** — Operations related to Achievements
- **Clubs** — Operations related to Clubs
- **Content** — Operations related to Content
- **Games** — Operations related to Games
- **Marketplace** — Operations related to Marketplace

## Why Jentic

- **Setup:** Wiring the XAPI Xbox API by hand means setting up its bearer auth and handling profile, presence, and conversation lookups yourself. Through Jentic you install once, import the XAPI Xbox API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The XAPI Xbox API puts the Xbox user id in the URL path (`/api/{xuid}/profile`, `/api/{xuid}/presence`), so a rule can pin your agent to one xuid: it can read that user's gamercard, presence, and activity. You choose the operations it may call, so it is mostly read-only lookups and only the ones you allow are available.
- **Credential handling:** Your XAPI Xbox API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'retrieve the authenticated user profile' or 'get a player's presence', and Jentic returns the matching XAPI Xbox API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Facebook** — Alternative social media API
- **Twitter** — Alternative social media API
- **Linkedin** — Complementary social media API

## FAQ

### What authentication does the XAPI Xbox API use?

The XAPI Xbox API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I retrieve authenticated user profile with the XAPI Xbox API?

Yes. Use the GET `/api/profile` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the XAPI Xbox API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I retrieve authenticated user profile through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'retrieve authenticated user profile'. Jentic returns the matching XAPI Xbox API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the XAPI Xbox API have?

The XAPI Xbox API exposes 34 endpoints covering achievements, clubs, content operations.

### Can I limit what my agent is allowed to do with the XAPI Xbox API?

Yes. Jentic One runs self-hosted, so your own rules decide which XAPI Xbox API operations and credentials the agent may use. Because the API puts the Xbox user id in the URL path, such as `/api/{xuid}/profile` and `/api/{xuid}/presence`, you can pin the agent to a single xuid and allow only read lookups like gamercard, presence, and activity. Any operation you do not grant stays unavailable to the agent.