canonical: https://jentic.com/apis/piggyback.gg/piggyback

# Piggyback Gg Piggyback API

The Piggyback API provides programmatic access to piggyback.gg platform services. This API enables developers to integrate piggyback.gg functionality into their applications through a RESTful interface. API documentation and service details are currently limited. Authentication is handled via API keys that are passed in request headers. Jentic provides secure credential management and schema discovery for the Piggyback API, enabling AI agents to interact with the service without exposing sensitive credentials in prompts or logs.

## For AI agents

Access piggyback.gg platform services programmatically through a RESTful API with API key authentication.

## Scope

Provides access to piggyback.gg platform services as defined in the API specification. Does not include platform-specific business logic, direct database access, or operations outside the API's intended scope.

## Capabilities

- Authenticate requests via API key authentication
- Access platform services through RESTful endpoints
- Manage resources programmatically
- Query platform data and metadata
- Execute operations on platform resources

## Use cases

### Platform Integration

Integrate piggyback.gg services into custom applications by using the API to access platform functionality. Developers can authenticate using API keys and make requests to available endpoints to retrieve data or perform operations. The API provides a programmatic interface for building integrations without manual platform interaction.

Example prompt: Authenticate with the piggyback.gg API using stored credentials, then execute requests to available endpoints based on the user's requirements.

### Automated Resource Management

Automate management of platform resources using the API instead of manual operations through the web interface. This use case enables scripting, automation workflows, and integration with other tools in the development pipeline. API access allows for consistent, repeatable operations.

Example prompt: Use the API to programmatically manage resources, retrieve status information, and execute operations based on automation rules or user requests.

### Data Retrieval and Analysis

Extract data from the piggyback.gg platform for analysis, reporting, or integration with business intelligence tools. The API provides programmatic access to platform data that can be queried, filtered, and exported for downstream processing. This enables data-driven decision making based on platform metrics.

Example prompt: Query the API for relevant data, apply filters as needed, and return structured results that can be processed or analyzed.

## Key resources

- **API Authentication** — API key-based authentication for securing access to platform resources
- **Platform Resources** — Core resources and entities managed through the API
- **API Endpoints** — RESTful endpoints for accessing platform functionality

## Why Jentic

- **Setup:** Wiring the Piggyback API by hand means setting up its API key auth and coding each platform call against the host yourself. Through Jentic you install once, import Piggyback from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** You scope Piggyback by operation: limit the agent to the operations it actually needs and leave the rest out, so it can only run the calls you allow. You choose that set, and anything you do not include stays unavailable to the agent.
- **Credential handling:** Your Piggyback API key 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 'access piggyback.gg data', and Jentic returns the matching Piggyback operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## FAQ

### What authentication does the Piggyback API use?

The Piggyback API uses API key authentication. Through Jentic, API keys are stored encrypted and injected into requests at execution time, ensuring credentials never appear in agent prompts or conversation logs.

### How do I get started with the Piggyback API?

To use the Piggyback API through Jentic, you'll need a valid API key from piggyback.gg. Store your credentials in Jentic's secure vault, then search for piggyback.gg endpoints to discover available operations and execute API calls.

### What can I do with the Piggyback API?

The Piggyback API provides programmatic access to platform services, enabling you to integrate piggyback.gg functionality into your applications, automate resource management, and retrieve data for analysis or reporting purposes.

### Is the Piggyback API free to use?

API access terms and pricing are determined by piggyback.gg. Check the piggyback.gg platform documentation or contact their support team for details on API access tiers and any associated costs.

### How do I use the Piggyback API with AI agents?

Through Jentic, AI agents can discover and call Piggyback API endpoints by searching for relevant operations. Jentic handles credential injection and schema loading, allowing agents to interact with the API without exposing sensitive data.

### Where can I find Piggyback API documentation?

Official API documentation should be available from piggyback.gg. Through Jentic, you can search for available endpoints and view their schemas to understand request parameters and response formats.

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

Yes. Because you run Jentic One yourself, you decide which Piggyback API operations your agent may call, scoping it by operation so it can only run the calls you allow. You import Piggyback and grant the agent just the platform operations it needs, such as querying platform data or managing specific resources, and leave every other operation out. Anything you do not include stays unavailable to the agent, and your piggyback.gg API key is stored encrypted by your own instance and injected only at execution time.
