UniPost

https://unipost.dev/docs
Admin
UniPost is a unified social media API and developer platform for cross-platform publishing, account...
Tokens:69,860
Snippets:851
Trust Score:2.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run Quickstart Setup

Source: https://unipost.dev/docs/cli/reference

Guides the setup process by summarizing workspace, profile, account, and draft readiness.

```bash
unipost quickstart --name "Studio" --json
```

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

### unipost quickstart

Source: https://unipost.dev/docs/cli/reference

Guides the setup process by summarizing workspace, profile, account, and draft readiness.

```APIDOC
## unipost quickstart

### Description
Guides the next setup step by summarizing workspace, profile, account, and draft readiness.

### Command
`unipost quickstart --name "Studio" --json`
```

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

### Install agent instructions

Source: https://unipost.dev/docs/cli/reference

Retrieves instruction package paths for local agent setup.

```bash
unipost agent install --client codex --json
```

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

### CLI installation and management

Source: https://unipost.dev/docs/cli

Commands for installing, initializing, and updating the UniPost CLI.

```bash
npm install -g @unipost/cli
```

```bash
unipost init
```

```bash
unipost
```

```bash
unipost upgrade
```

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

### Install the UniPost CLI

Source: https://unipost.dev/docs/cli

Global installation command for the UniPost CLI via npm.

```bash
npm install -g @unipost/cli
```

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

### Authenticate with Setup Token

Source: https://unipost.dev/docs/cli/reference

Exchanges a setup token for a local CLI credential. Use --replace-key, --reauth, or --yes to overwrite existing bindings.

```bash
unipost auth login --setup-token ust_... --client terminal --base-url https://api.unipost.dev --json
```

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

### Generate post creation example

Source: https://unipost.dev/docs/cli/reference

Generates a cURL or native Node fetch example for creating a post.

```bash
unipost examples posts.create --lang node --account sa_1 --caption "Hello" --json
```

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

### Verify CLI Installation

Source: https://unipost.dev/docs/cli

Commands to verify the CLI is installed and check the current version.

```bash
unipost --help
```

```bash
npm bin -g
```

```bash
unipost upgrade
```

```bash
unipost --version
```

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

### Generate MCP setup command

Source: https://unipost.dev/docs/cli/reference

Prints the Claude Code MCP setup command and authentication test command.

```bash
unipost examples mcp.claude-code --json
```

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

### unipost --version

Source: https://unipost.dev/docs/cli/reference

Prints the currently installed version of the CLI.

```APIDOC
## unipost --version

### Description
Prints the installed CLI version.
```

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

### Get agent prompt guidance

Source: https://unipost.dev/docs/cli/reference

Retrieves client-specific instructions for CLI and MCP operation.

```bash
unipost agent guide --client codex --json
```

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

### GET /v1/api-keys

Source: https://unipost.dev/docs/api/api-keys/list

Lists all API keys for the authenticated workspace.

```APIDOC
## GET /v1/api-keys

### Description
Lists API keys for the authenticated workspace.

### Method
GET

### Endpoint
/v1/api-keys

### Authorization
- **Authorization** (Header) - Required - Bearer <token>

### Response
#### Success Response (200)
- **data** (array) - API keys for the authenticated workspace.
  - **id** (string) - API key record ID.
  - **name** (string) - Human-readable label.
  - **prefix** (string) - Safe key prefix such as up_live_abcd.
  - **environment** (string) - "production" or "test".
  - **created_at** (string) - Creation timestamp.
  - **last_used_at** (string | null) - Last request timestamp, if used.
  - **expires_at** (string | null) - Optional expiration timestamp.
- **meta.total** (number) - Total API keys returned.
- **meta.limit** (number) - Applied list limit.
- **request_id** (string) - Request identifier for debugging and support.

#### Error Response (401, 500)
- **error.code** (string) - Usually "UNAUTHORIZED" or "INTERNAL_ERROR".
- **error.normalized_code** (string) - Lowercase alias such as "unauthorized".
- **error.message** (string) - Human-readable error message.
- **request_id** (string) - Request identifier for debugging and support.
```

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

### GET /v1/accounts/{id}/capabilities

Source: https://unipost.dev/docs/api

Inspect publish and media support.

```APIDOC
## GET /v1/accounts/{id}/capabilities

### Description
Inspect publish and media support.

### Method
GET

### Endpoint
/v1/accounts/{id}/capabilities

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

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

### Check CLI Version

Source: https://unipost.dev/docs/cli/reference

Displays the currently installed version of the CLI.

```bash
unipost --version
```

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

### Get agent context

Source: https://unipost.dev/docs/cli/reference

Returns workspace, profile, and account data for agent grounding.

```bash
unipost agent context --json
```

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

### Get Config Path

Source: https://unipost.dev/docs/cli/reference

Prints the file system path of the local CLI configuration.

```bash
unipost config path --json
```

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

### Manage Profiles and Accounts

Source: https://unipost.dev/docs/cli

Commands to list profiles, initialize quickstarts, and manage account connections.

```bash
unipost profiles list --json
```

```bash
unipost quickstart --name "Brand" --json
```

```bash
unipost connect create --json
```

```bash
unipost accounts list --json
```

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

### GET /v1/workspace

Source: https://unipost.dev/docs/api/workspace/get

Returns the workspace bound to the authenticated caller. API-key callers get the workspace the key belongs to; dashboard (Clerk) callers get the user's workspace.

```APIDOC
## GET /v1/workspace

### Description
Returns the workspace bound to the authenticated caller. There is one workspace per account.

### Method
GET

### Endpoint
/v1/workspace

### Authorization
- **Authorization** (Header) - Required - Bearer <token> (Workspace API key or Clerk session JWT)

### Response
#### Success Response (200)
- **id** (string) - Workspace ID.
- **name** (string) - Human-readable workspace name.
- **per_account_monthly_limit** (number | null) - Optional per-account monthly publish quota.
- **usage_modes** (string[]) - Active usage modes selected during onboarding (publishing, agentic).
- **custom_platform_slot** (string | null) - Shared Basic custom platform slot.
- **created_at** (string) - Creation timestamp.
- **updated_at** (string) - Last update timestamp.

#### Error Response (401, 500)
- **error.code** (string) - Error code.
- **error.normalized_code** (string) - Lowercase alias for the error.
- **error.message** (string) - Human-readable error message.
- **request_id** (string) - Request identifier for debugging.
```

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

### Initialize UniPost CLI

Source: https://unipost.dev/docs/cli/reference

Initializes local configuration and creates the first workspace context.

```bash
unipost init --json
```

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

### Display CLI Help

Source: https://unipost.dev/docs/cli/reference

Shows top-level usage, commands, flags, and installation notes.

```bash
unipost --help
```

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

### unipost init

Source: https://unipost.dev/docs/cli/reference

Initializes the local configuration and workspace context.

```APIDOC
## unipost init

### Description
Checks authentication, loads workspace/profile context, and writes safe local defaults.

### Command
`unipost init --json`
```

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

### GET /v1/webhooks

Source: https://unipost.dev/docs/api

List all webhook subscriptions.

```APIDOC
## GET /v1/webhooks

### Description
List webhook subscriptions.

### Method
GET

### Endpoint
/v1/webhooks
```

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

### GET /v1/posts

Source: https://unipost.dev/docs/api

List posts in a workspace.

```APIDOC
## GET /v1/posts

### Description
List posts in a workspace.

### Method
GET

### Endpoint
/v1/posts
```

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

### Display Self-management Help

Source: https://unipost.dev/docs/cli/reference

Lists commands related to installation, updates, versioning, and diagnostics.

```bash
unipost self help
```

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

### GET /v1/users

Source: https://unipost.dev/docs/api

List all managed users in the workspace.

```APIDOC
## GET /v1/users

### Description
List managed users.

### Method
GET

### Endpoint
/v1/users
```

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

### unipost --help

Source: https://unipost.dev/docs/cli/reference

Displays top-level usage, supported commands, global flags, and installation notes.

```APIDOC
## unipost --help

### Description
Prints top-level usage, supported commands, global flags, install, and upgrade notes.
```

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

### GET /v1/workspace

Source: https://unipost.dev/docs/api

Fetch metadata for the current workspace.

```APIDOC
## GET /v1/workspace

### Description
Fetch workspace metadata.

### Method
GET

### Endpoint
/v1/workspace
```

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

### Bootstrap agent environment

Source: https://unipost.dev/docs/cli

Initialize an agent session with a specific client configuration.

```bash
unipost agent bootstrap --client codex --json
```

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

### GET /v1/analytics/summary

Source: https://unipost.dev/docs/api

Read workspace-level analytics cards.

```APIDOC
## GET /v1/analytics/summary

### Description
Read workspace-level analytics cards.

### Method
GET

### Endpoint
/v1/analytics/summary
```

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

### POST /v1/connect/sessions

Source: https://unipost.dev/docs/api/connect/sessions/create

Creates a new hosted onboarding session for a social account.

```APIDOC
## POST /v1/connect/sessions

### Description
Creates a hosted onboarding session for a customer-owned social account. Use the returned URL to send the end user into UniPost's managed Connect flow.

### Method
POST

### Endpoint
/v1/connect/sessions

### Parameters
#### Request Body
- **platform** (string) - Required - Destination platform for the hosted onboarding flow. Values: twitter, linkedin, bluesky, youtube, tiktok, instagram, threads, facebook, pinterest
- **profile_id** (string) - Optional - Profile that should own the resulting connected account. Required when the workspace has multiple profiles.
- **external_user_id** (string) - Required - Your stable end-user identifier.
- **external_user_email** (string) - Optional - Optional email for reconciliation and support.
- **return_url** (string) - Optional - Where UniPost redirects the user after completion, cancellation, or a handled OAuth failure.
- **allow_quickstart_creds** (boolean) - Optional - Optional escape hatch for OAuth platforms. Defaults to false.

### Response
#### Success Response (201)
- **id** (string) - Connect session ID.
- **url** (string) - Hosted onboarding URL to redirect the user to.
- **allow_quickstart_creds** (boolean) - Whether this session is allowed to fall back to UniPost's shared Quickstart OAuth app.
- **managed_account_id** (string) - Present after the session completes.
- **status** (string) - Session lifecycle state (pending, completed, expired, cancelled).
- **expires_at** (string) - Expiration timestamp for the hosted session.
```

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

### GET /v1/accounts

Source: https://unipost.dev/docs/api

List connected social accounts.

```APIDOC
## GET /v1/accounts

### Description
List connected social accounts.

### Method
GET

### Endpoint
/v1/accounts
```

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

### Upload media via CLI

Source: https://unipost.dev/docs/cli/reference

Reserves a media record, uploads the local file, and waits for readiness.

```bash
unipost media upload ./video.mp4 --json
```

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

### unipost connect get

Source: https://unipost.dev/docs/cli/reference

Retrieves the status of a connection session.

```APIDOC
## unipost connect get

### Description
Reads the current status of a connect session.

### Command
`unipost connect get [session_id] --json`
```

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

### GET /v1/media/:media_id

Source: https://unipost.dev/docs/guides/video-audio-overlay

Poll the status of a media upload.

```APIDOC
## GET /v1/media/:media_id

### Description
Poll this endpoint to check the status of a media upload.

### Method
GET

### Endpoint
/v1/media/:media_id
```

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

### GET /v1/media/{id}

Source: https://unipost.dev/docs/api

Fetch uploaded media metadata.

```APIDOC
## GET /v1/media/{id}

### Description
Fetch uploaded media metadata.

### Method
GET

### Endpoint
/v1/media/{id}

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

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

### Connect an Account

Source: https://unipost.dev/docs/platforms

Use the bash command to initiate an account connection process.

```bash
Loading...
```

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

### GET /v1/posts/{id}

Source: https://unipost.dev/docs/api

Fetch a post and delivery results.

```APIDOC
## GET /v1/posts/{id}

### Description
Fetch a post and delivery results.

### Method
GET

### Endpoint
/v1/posts/{id}

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

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

### Create a workspace profile

Source: https://unipost.dev/docs/cli/reference

Initializes a new workspace profile with a specified name.

```bash
unipost profiles create --name "Studio" --json
```

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

### unipost auth login

Source: https://unipost.dev/docs/cli/reference

Authenticates the CLI using a setup token or an API key.

```APIDOC
## unipost auth login

### Description
Exchanges a setup token or validates an API key to store a local CLI credential.

### Commands
`unipost auth login --setup-token ust_... --client terminal --base-url https://api.unipost.dev --json`
`unipost auth login --api-key up_live_... --json`
```

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

### GET /v1/profiles/{id}

Source: https://unipost.dev/docs/api

Fetch one profile by ID.

```APIDOC
## GET /v1/profiles/{id}

### Description
Fetch one profile by ID.

### Method
GET

### Endpoint
/v1/profiles/{id}

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

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

### Create post via CLI

Source: https://unipost.dev/docs/cli/reference

Creates a post from a file. Use --dry-run for validation; live writes require --yes and an idempotency key.

```bash
unipost posts create --from-file post.json --dry-run --json
```

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

### GET /v1/inbox

Source: https://unipost.dev/docs/api/inbox

List inbox items for the selected scope.

```APIDOC
## GET /v1/inbox

### Description
List inbox items for the selected scope.

### Method
GET

### Endpoint
/v1/inbox
```

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

### Create workspace-credential session

Source: https://unipost.dev/docs/connect-sessions

Requires pre-uploaded workspace Platform Credentials; set allow_quickstart_creds to false to ensure immediate failure if credentials are missing.

```cURL
curl -X POST https://api.unipost.com/sessions \
  -d 'allow_quickstart_creds=false'
```

```Node.js
const session = await unipost.sessions.create({
  allow_quickstart_creds: false
});
```

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

### Get post details via CLI

Source: https://unipost.dev/docs/cli/reference

Fetches a single post and its associated platform result state.

```bash
unipost posts get post_1 --json
```

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

### GET /v1/users/{external_user_id}

Source: https://unipost.dev/docs/api

Fetch details for a specific managed user.

```APIDOC
## GET /v1/users/{external_user_id}

### Description
Fetch one managed user.

### Method
GET

### Endpoint
/v1/users/{external_user_id}

### Parameters
#### Path Parameters
- **external_user_id** (string) - Required - The external user identifier.
```

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

### GET /v1/api-metrics/summary

Source: https://unipost.dev/docs/api

List per-endpoint API latency and error rows.

```APIDOC
## GET /v1/api-metrics/summary

### Description
List per-endpoint API latency and error rows.

### Method
GET

### Endpoint
/v1/api-metrics/summary
```

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

### Create shared-app fallback session

Source: https://unipost.dev/docs/connect-sessions

Use this configuration for hosted customer onboarding without requiring workspace-owned Platform Credentials.

```cURL
curl -X POST https://api.unipost.com/sessions \
  -d 'allow_quickstart_creds=true'
```

```Node.js
const session = await unipost.sessions.create({
  allow_quickstart_creds: true
});
```

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

### unipost accounts get

Source: https://unipost.dev/docs/cli/reference

Retrieves details for a specific connected account.

```APIDOC
## unipost accounts get

### Description
Finds one account from the workspace account list.

### Command
`unipost accounts get [account_id] --json`
```

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

### unipost profiles get

Source: https://unipost.dev/docs/cli/reference

Fetches a specific workspace profile by its ID.

```APIDOC
## unipost profiles get

### Description
Fetches one profile by ID.

### Command
`unipost profiles get [profile_id] --json`
```

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

### Execute Local Connect Session Script

Source: https://unipost.dev/docs/local-connect-test

Run the Python script with required environment variables to generate a hosted OAuth URL.

```bash
export UNIPOST_API_KEY="your_api_key"
export PROFILE_ID="your_profile_id"
export PLATFORM="youtube"
python3 create_connect_session_url.py --allow-quickstart-creds
```

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

### GET /v1/posts/:post_id

Source: https://unipost.dev/docs/publishing

Retrieve the status of an asynchronous publishing request.

```APIDOC
## GET /v1/posts/:post_id

### Description
Retrieves the current status and final result of a post creation request.

### Method
GET

### Endpoint
/v1/posts/:post_id

### Parameters
#### Path Parameters
- **post_id** (string) - Required - The unique identifier of the post.
```

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

### Show Configuration

Source: https://unipost.dev/docs/cli/reference

Displays redacted local CLI configuration settings.

```bash
unipost config show --json
```

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

### unipost connect create

Source: https://unipost.dev/docs/cli/reference

Initiates a hosted OAuth connection session.

```APIDOC
## unipost connect create

### Description
Creates a hosted OAuth connect session for a platform and profile.

### Command
`unipost connect create --platform [platform] --profile [profile_id] --json`
```

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

### GET /v1/media/audio-overlays/{id}

Source: https://unipost.dev/docs/guides/video-audio-overlay

Poll the status of an audio overlay job.

```APIDOC
## GET /v1/media/audio-overlays/{id}

### Description
Poll this endpoint to check the status of an audio overlay job. When status is 'succeeded', the output_media_id is available.

### Method
GET

### Endpoint
/v1/media/audio-overlays/{id}
```

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

### GET /v1/accounts/{id}/tiktok/creator-info

Source: https://unipost.dev/docs/api

Fetch TikTok publishing limits.

```APIDOC
## GET /v1/accounts/{id}/tiktok/creator-info

### Description
Fetch TikTok publishing limits.

### Method
GET

### Endpoint
/v1/accounts/{id}/tiktok/creator-info

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

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

### List posts via CLI

Source: https://unipost.dev/docs/cli/reference

Lists posts with optional status filtering and pagination.

```bash
unipost posts list --status failed --limit 10 --json
```
Tokens:
Raw