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

# Publish a post

> Publish a post to your public BudgetPixel feed — the same posts you create on the
site, so your local agent can publish on your behalf. **Synchronous**: the response
carries the live post's `id` and `url`.

**Pricing: 10 credits per successful post**, charged only on success. Estimate via
[`POST /v1/cost`](/api-reference/models/estimate-the-cost-of-a-request) with
`{"model": "create-post"}`.

**Media composition** (one of):
- **Images** — 1 to 6 images. Each image can optionally carry `model` and
  `prompt` generation info, shown on the image's info panel on the post.
- **Video** — exactly 1 video, optionally with up to 3 accompanying images.
- **Audio** — exactly 1 audio file (cannot mix with other media). Supports
  `song_name`, `genre`, and `lyrics`.

Each `media[].file` accepts a public URL, an uploaded-file URL from
[`POST /v1/uploads`](/api-reference/files/upload-input-media), a data URI, or raw
base64. **Size limits:** images 15 MB; audio 50 MB; video 100 MB — note that URL
inputs are fetched with a 30 MB cap and uploads support up to 50 MB, so ~50 MB is
the practical video ceiling via the API.

**Limits & moderation:**
- The API allows **5 posts per hour**, inside the site-wide limit of **20 posts
  per hour** per account across all surfaces (shares included) — both on top of
  the API's global rate limits. Exceeding any of them returns `429`.
- Posting a byte-identical file you've already posted returns `409` with the
  existing post's id.
- Posts published through the API carry a public **"via API"** label, like posts
  made with an Ava companion carry hers.
- Image/video posts are **reviewed after publishing** (content rating and spam
  scoring). Feed and gallery visibility follow that review and your account
  standing; a post hidden by review is not refunded.




## OpenAPI

````yaml /openapi.yaml post /posts
openapi: 3.1.0
info:
  contact:
    email: support@budgetpixel.com
    name: BudgetPixel Support
  description: >
    The BudgetPixel developer API for programmatic image and video generation.


    Generation is **asynchronous**: you create a job, then poll its status until
    it

    reaches a terminal state (`succeeded` / `failed`). You are charged in
    credits

    only on success — never for failures, timeouts, or content blocked before

    generation.


    **Authentication.** All requests require an API key sent as a bearer token:

        Authorization: Bearer bpx_live_xxx

    Create and manage keys from your BudgetPixel account dashboard. The
    developer

    API is currently available on the **Ultra** plan.


    **Pricing.** API usage is metered in credits at each model's published price

    (see `GET /v1/models`). Consumer subscription perks (free daily generations,

    free-for-Ultra models, subscription discounts) do not apply to API traffic.
  title: BudgetPixel API
  version: '2026-06-20'
servers:
  - description: Production
    url: https://api.budgetpixel.com/v1
security:
  - ApiKeyAuth: []
tags:
  - description: Account and credit balance
    name: Account
  - description: Discover available models and pricing
    name: Models
  - description: Upload input media for image/video generation
    name: Uploads
  - description: Image job status
    name: Images
  - description: FLUX image models
    name: Black Forest Labs
  - description: SeeDream image models
    name: Bytedance
  - description: Video job status
    name: Videos
  - description: Kuaishou Kling video models
    name: Kling
  - description: SeeDance video models
    name: ByteDance (SeeDance)
  - description: Music job status
    name: Audios
  - description: Music generation models
    name: Music
  - description: Format conversion for images, video, and audio
    name: Conversions
  - description: Publish posts to your BudgetPixel feed
    name: Social
  - description: Content moderation — NSFW rating and CSAM detection
    name: Moderation
  - description: Content classification — music genre detection
    name: Classification
paths:
  /posts:
    post:
      tags:
        - Social
      summary: Publish a post
      description: >
        Publish a post to your public BudgetPixel feed — the same posts you
        create on the

        site, so your local agent can publish on your behalf. **Synchronous**:
        the response

        carries the live post's `id` and `url`.


        **Pricing: 10 credits per successful post**, charged only on success.
        Estimate via

        [`POST /v1/cost`](/api-reference/models/estimate-the-cost-of-a-request)
        with

        `{"model": "create-post"}`.


        **Media composition** (one of):

        - **Images** — 1 to 6 images. Each image can optionally carry `model`
        and
          `prompt` generation info, shown on the image's info panel on the post.
        - **Video** — exactly 1 video, optionally with up to 3 accompanying
        images.

        - **Audio** — exactly 1 audio file (cannot mix with other media).
        Supports
          `song_name`, `genre`, and `lyrics`.

        Each `media[].file` accepts a public URL, an uploaded-file URL from

        [`POST /v1/uploads`](/api-reference/files/upload-input-media), a data
        URI, or raw

        base64. **Size limits:** images 15 MB; audio 50 MB; video 100 MB — note
        that URL

        inputs are fetched with a 30 MB cap and uploads support up to 50 MB, so
        ~50 MB is

        the practical video ceiling via the API.


        **Limits & moderation:**

        - The API allows **5 posts per hour**, inside the site-wide limit of
        **20 posts
          per hour** per account across all surfaces (shares included) — both on top of
          the API's global rate limits. Exceeding any of them returns `429`.
        - Posting a byte-identical file you've already posted returns `409` with
        the
          existing post's id.
        - Posts published through the API carry a public **"via API"** label,
        like posts
          made with an Ava companion carry hers.
        - Image/video posts are **reviewed after publishing** (content rating
        and spam
          scoring). Feed and gallery visibility follow that review and your account
          standing; a post hidden by review is not refunded.
      operationId: createPost
      requestBody:
        content:
          application/json:
            schema:
              properties:
                content:
                  description: Optional caption (max 2000 characters).
                  type: string
                genre:
                  description: Audio posts only — must be one of the site's music genres.
                  type: string
                lyrics:
                  description: Audio posts only.
                  type: string
                media:
                  description: >-
                    The post's media items, in display order. One of: 1-6
                    images; OR exactly 1 video plus up to 3 images; OR exactly 1
                    audio file (audio can't mix with other media).
                  items:
                    properties:
                      file:
                        description: >-
                          Public URL, uploaded-file URL, data URI, or raw
                          base64.
                        type: string
                      model:
                        description: >-
                          Images only — the model that generated this image,
                          shown on the image's info panel (e.g.
                          `seedream-5.0-pro`).
                        maxLength: 100
                        type: string
                      prompt:
                        description: >-
                          Images only — the prompt that generated this image,
                          shown on the image's info panel.
                        maxLength: 10000
                        type: string
                      type:
                        description: >-
                          Optional declared kind — validated against the file's
                          actual content.
                        enum:
                          - image
                          - video
                          - audio
                        type: string
                    required:
                      - file
                    type: object
                  maxItems: 6
                  minItems: 1
                  type: array
                song_name:
                  description: Audio posts only — track title.
                  type: string
              required:
                - media
              type: object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePostResponse'
          description: Post published.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Insufficient credits to publish.
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Duplicate media — you already posted a byte-identical file.
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    CreatePostResponse:
      description: A published post.
      properties:
        credits_charged:
          example: 10
          type: integer
        id:
          description: The post id.
          type: integer
        media_type:
          enum:
            - image
            - video
            - audio
          type: string
        moderation:
          description: >-
            Image/video posts are rated after publish; feed visibility follows
            the review.
          example: pending
          type: string
        url:
          description: Public URL of the post.
          example: https://budgetpixel.com/p/12345
          format: uri
          type: string
      type: object
    Error:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable code.
              example: model_not_available
              type: string
            message:
              type: string
            type:
              description: Error category.
              example: invalid_request_error
              type: string
          required:
            - type
            - code
            - message
          type: object
      required:
        - error
      type: object
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: The request was malformed or referenced an unavailable model.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Missing or invalid API key.
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Authenticated but not permitted (plan gate, ownership, restriction).
    TooManyRequests:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Rate or queue limit reached. Retry after a short delay.
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: bpx_live_*
      description: 'API key as a bearer token: Authorization: Bearer bpx_live_xxx'
      scheme: bearer
      type: http

````