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

# Create a review-first Reddit campaign and its driving agent.

> The selected account must be a connected Reddit account in this workspace. Posts remain human-reviewed; automatic replies apply only to comments on your own posts.



## OpenAPI

````yaml /openapi.json post /v1/reddit-campaigns
openapi: 3.1.0
info:
  title: Sigmora API
  version: 1.0.0
  description: >-
    The priced, versioned public API. Every call authenticates with a workspace
    API key (`Authorization: Bearer sk_live_…`), names the project it files its
    output under, and reports what it cost. `GET /v1/capabilities` answers what
    this deployment can serve right now and at what price; anything it reports
    as unavailable answers 503 `capability_unavailable` rather than 404.
servers:
  - url: https://api.sigmora.org
security:
  - bearerAuth: []
paths:
  /v1/reddit-campaigns:
    post:
      summary: Create a review-first Reddit campaign and its driving agent.
      description: >-
        The selected account must be a connected Reddit account in this
        workspace. Posts remain human-reviewed; automatic replies apply only to
        comments on your own posts.
      parameters:
        - name: idempotency-key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                connectedAccountId:
                  type: string
                  minLength: 1
                  maxLength: 200
                brandBrainId:
                  default: null
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 200
                    - type: 'null'
                objective:
                  type: string
                  minLength: 1
                  maxLength: 2000
                offerUrl:
                  type: string
                  format: uri
                keywords:
                  minItems: 1
                  maxItems: 25
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 80
                negativeKeywords:
                  maxItems: 25
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 80
                caps:
                  default:
                    maxPostsPerDay: 1
                    maxCommentsPerDay: 5
                    maxActionsPerDay: 6
                    promoRatioPct: 10
                    perSubPostsPerDay: 1
                  type: object
                  properties:
                    maxPostsPerDay:
                      default: 1
                      type: integer
                      minimum: 0
                      maximum: 10
                    maxCommentsPerDay:
                      default: 5
                      type: integer
                      minimum: 0
                      maximum: 25
                    maxActionsPerDay:
                      default: 6
                      type: integer
                      minimum: 0
                      maximum: 30
                    promoRatioPct:
                      default: 10
                      type: integer
                      minimum: 1
                      maximum: 50
                    perSubPostsPerDay:
                      default: 1
                      type: integer
                      minimum: 1
                      maximum: 3
                autoReplyOurPosts:
                  default: false
                  type: boolean
                schedule:
                  type: object
                  properties:
                    daysOfWeek:
                      minItems: 1
                      type: array
                      items:
                        type: integer
                        minimum: 0
                        maximum: 6
                    everyNHours:
                      type: number
                      exclusiveMinimum: 0
                    window:
                      type: object
                      properties:
                        start:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                        end:
                          type: string
                          pattern: ^([01]\d|2[0-3]):[0-5]\d$
                      required:
                        - start
                        - end
                    timezone:
                      type: string
                      minLength: 1
                      maxLength: 100
                    maxRunsPerDay:
                      type: integer
                      exclusiveMinimum: 0
                      maximum: 9007199254740991
                  required:
                    - daysOfWeek
                    - everyNHours
                    - window
                    - timezone
                    - maxRunsPerDay
                quietHours:
                  type: object
                  properties:
                    start:
                      type: string
                      pattern: ^([01]\d|2[0-3]):[0-5]\d$
                    end:
                      type: string
                      pattern: ^([01]\d|2[0-3]):[0-5]\d$
                  required:
                    - start
                    - end
                alertEmail:
                  default: null
                  anyOf:
                    - type: string
                      format: email
                      pattern: >-
                        ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
                    - type: 'null'
              required:
                - name
                - connectedAccountId
                - objective
                - keywords
                - schedule
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  campaign:
                    type: object
                    properties:
                      id:
                        type: string
                      agentId:
                        type: string
                      name:
                        type: string
                      status:
                        type: string
                        enum:
                          - active
                          - paused
                          - completed
                      connectedAccountId:
                        type: string
                      brandBrainId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      objective:
                        type: string
                      offerUrl:
                        type: string
                        format: uri
                      smartLinkId:
                        type: string
                      keywords:
                        type: array
                        items:
                          type: string
                      negativeKeywords:
                        type: array
                        items:
                          type: string
                      targetSubreddits:
                        type: array
                        items:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties: {}
                      caps:
                        type: object
                        properties:
                          maxPostsPerDay:
                            default: 1
                            type: integer
                            minimum: 0
                            maximum: 10
                          maxCommentsPerDay:
                            default: 5
                            type: integer
                            minimum: 0
                            maximum: 25
                          maxActionsPerDay:
                            default: 6
                            type: integer
                            minimum: 0
                            maximum: 30
                          promoRatioPct:
                            default: 10
                            type: integer
                            minimum: 1
                            maximum: 50
                          perSubPostsPerDay:
                            default: 1
                            type: integer
                            minimum: 1
                            maximum: 3
                      autoReplyOurPosts:
                        type: boolean
                      accountReadiness:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      activity:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      weeklyPlan:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      metrics:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      marketingCampaignId:
                        type: string
                      marketingLibraryVersion:
                        type: string
                      marketingManifest:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      createdAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                      updatedAt:
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    required:
                      - id
                      - name
                      - status
                      - connectedAccountId
                      - objective
                      - keywords
                      - targetSubreddits
                      - caps
                      - autoReplyOurPosts
                      - createdAt
                      - updatedAt
                    additionalProperties: {}
                  agent:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                required:
                  - success
                  - campaign
                  - agent
                additionalProperties: {}
        '400':
          description: 'Failure. `code` is one of: invalid_request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Failure. `code` is one of: unauthorized.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: 'Failure. `code` is one of: insufficient_credits, budget_capped.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Failure. `code` is one of: forbidden, origin_not_allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Failure. `code` is one of: not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: 'Failure. `code` is one of: conflict.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: 'Failure. `code` is one of: payload_too_large.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Failure. `code` is one of: rate_limited.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Failure. `code` is one of: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: 'Failure. `code` is one of: upstream_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            Failure. `code` is one of: capability_unavailable,
            upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: >-
            Human-readable. Copy may change between releases — do not match on
            it.
        code:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - forbidden
            - origin_not_allowed
            - not_found
            - conflict
            - payload_too_large
            - insufficient_credits
            - budget_capped
            - rate_limited
            - capability_unavailable
            - upstream_unavailable
            - upstream_error
            - internal_error
          description: Stable machine-readable cause. Branch on this.
        details:
          description: Optional structured context, e.g. the credits shortfall.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A workspace API key.

````