> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ugc.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Official API documentation for UGC Inc - Automate TikTok and Instagram content creation

## Welcome to UGC Inc API

The UGC Inc API allows you to programmatically manage social media accounts, create and schedule posts, track statistics, and automate account warming tasks for TikTok and Instagram.

## Base URL

All API requests should be made to:

```
https://api.ugc.inc
```

## Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

### Getting Your API Key

To access accounts and receive an API key:

1. Visit [ugc.inc](https://ugc.inc)
2. **Schedule a call** with our team
3. After your call, you'll receive access to accounts and your API key

<Warning>
  **Keep your API key secure!** Never commit it to version control or expose it in client-side code.
</Warning>

### Restricted Keys

A key can be issued with restrictions, so that an integration only holds the
access it actually needs. A standard key has none of these and works across
your whole organization.

| Restriction      | Effect                                                                                                            |
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
| Expiry           | The key stops working at a fixed time. Requests after it return `401`.                                            |
| Scopes           | The key may only perform specific operations. Anything else returns `403`.                                        |
| Resource binding | The key may only act on named accounts or posts. Other resources return `403`, even within your own organization. |

If a request fails with `403`, the key is valid but is not permitted for that
operation or that resource — request a key with the access you need rather than
retrying.

## Installation

### NPM Package (Recommended)

We provide an official TypeScript/JavaScript client with full type safety:

```bash theme={null}
npm install ugcinc
```

```typescript theme={null}
import { UGCClient } from 'ugcinc';

const client = new UGCClient({
  apiKey: 'your-api-key-here'
});
```

### Direct API Calls

You can also make direct HTTP requests to the API endpoints using any HTTP client.

## Next Steps

Explore the documentation to learn more:

* **Response** - Learn about the consistent response format and error handling
* **Data Structures** - Understand the core data models (Account, Post, Task, Stats)
* **Posts** - Create and schedule content
* **Accounts** - Manage social media accounts
* **Render** - Generate videos and images programmatically
* **Statistics** - Track performance metrics
* **Tasks** - Automate account activities