SymphonyOS API

openapi: 3.1.0
info:
  title: SymphonyOS API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 6 operation(s) read from 36 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; SymphonyOS has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 1
    pages-with-code: 2
    pages-read: 36
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.symphonyos.co/reference/getbrands.md
  - https://docs.symphonyos.co/reference/createbrand.md
  - https://docs.symphonyos.co/reference/getbrands-1.md
  - https://docs.symphonyos.co/reference/getcampaign.md
  - https://docs.symphonyos.co/reference/updatebrand.md
  - https://docs.symphonyos.co/reference/listwebhooks.md
  - https://docs.symphonyos.co/reference/createbrand-1.md
  - https://docs.symphonyos.co/reference/createwebhook.md
  - https://docs.symphonyos.co/reference/deletewebhook.md
  - https://docs.symphonyos.co/reference/getcampaign-1.md
  - https://docs.symphonyos.co/reference/listcampaigns.md
  - https://docs.symphonyos.co/reference/updatebrand-1.md
  - https://docs.symphonyos.co/reference/updatewebhook.md
  - https://docs.symphonyos.co/reference/createcampaign.md
  - https://docs.symphonyos.co/reference/listwebhooks-1.md
  - https://docs.symphonyos.co/reference/testconnection.md
  - https://docs.symphonyos.co/reference/updatecampaign.md
  - https://docs.symphonyos.co/reference/createwebhook-1.md
  - https://docs.symphonyos.co/reference/deletewebhook-1.md
  - https://docs.symphonyos.co/reference/listcampaigns-1.md
  - https://docs.symphonyos.co/reference/searchinterests.md
  - https://docs.symphonyos.co/reference/searchlanguages.md
  - https://docs.symphonyos.co/reference/updatewebhook-1.md
  - https://docs.symphonyos.co/reference/createcampaign-1.md
  - https://docs.symphonyos.co/reference/testconnection-1.md
  - https://docs.symphonyos.co/reference/updatecampaign-1.md
  - https://docs.symphonyos.co/reference/getbrandcampaigns.md
  - https://docs.symphonyos.co/reference/searchgeographies.md
  - https://docs.symphonyos.co/reference/searchinterests-1.md
  - https://docs.symphonyos.co/reference/searchlanguages-1.md
  - https://docs.symphonyos.co/reference/getbrandcampaigns-1.md
  - https://docs.symphonyos.co/reference/searchgeographies-1.md
  - https://docs.symphonyos.co/reference/getcampaignanalytics.md
  - https://docs.symphonyos.co/reference/getcampaignanalytics-1.md
  - https://docs.symphonyos.co/docs/webhooks.md
  - https://docs.symphonyos.co/docs/advertising-api.md
servers:
- url: https://api.symphonyos.co
paths:
  /api/sym/v2/webhooks:
    post:
      operationId: post_api_sym_v2_webhooks
      tags:
      - Api
      summary: POST /api/sym/v2/webhooks
      x-source: https://docs.symphonyos.co/docs/webhooks.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSymV2WebhooksRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSymV2WebhooksResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.symphonyos.co/api/sym/v2/webhooks  -H \"x-api-key: YOUR_API_KEY\"  -H \"Content-Type: application/json\"\
          \  -d '{\n    \"url\": \"https://your-app.com/webhooks/symphony\",\n    \"eventType\": \"campaign.created\"\n  }'\n```"
  /api/sym/v2/webhooks/3:
    delete:
      operationId: delete_api_sym_v2_webhooks_3
      tags:
      - Api
      summary: DELETE /api/sym/v2/webhooks/3
      x-source: https://docs.symphonyos.co/docs/webhooks.md
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiSymV2Webhooks3Response'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X DELETE https://api.symphonyos.co/api/sym/v2/webhooks/3  -H "x-api-key: YOUR_API_KEY"

          ```'
    put:
      operationId: put_api_sym_v2_webhooks_3
      tags:
      - Api
      summary: PUT /api/sym/v2/webhooks/3
      x-source: https://docs.symphonyos.co/docs/webhooks.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiSymV2Webhooks3Request'
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutApiSymV2Webhooks3Response'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PUT https://api.symphonyos.co/api/sym/v2/webhooks/3  -H \"x-api-key: YOUR_API_KEY\"  -H \"Content-Type: application/json\"\
          \  -d '{\n    \"url\": \"https://your-app.com/webhooks/v2/symphony\"\n  }'\n```"
  /api/sym/v2/{v2id}:
    get:
      operationId: get_api_sym_v2_v2id
      tags:
      - Api
      summary: GET /api/sym/v2/api-test
      x-source: https://docs.symphonyos.co/docs/advertising-api.md
      parameters:
      - name: v2id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSymV2V2IdResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://api.symphonyos.co/api/sym/v2/api-test  -H "x-api-key: your-api-key"

          ```'
        collapsed_from: 2 example path(s) differing only at v2Id
  /campaigns:
    post:
      operationId: post_campaigns
      tags:
      - Campaigns
      summary: Create campaigns
      x-source: https://docs.symphonyos.co/docs/advertising-api.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /campaigns/{campaignid}:
    get:
      operationId: get_campaigns_campaignid
      tags:
      - Campaigns
      summary: Get a campaign
      description: Returns details for a single campaign by ID.
      x-source: https://docs.symphonyos.co/reference/getcampaign.md
      parameters:
      - name: campaignid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCampaignsCampaignidResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiSymV2WebhooksRequest:
      type: object
      properties:
        url:
          type: string
        eventType:
          type: string
    PostApiSymV2WebhooksResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: integer
            url:
              type: string
            status:
              type: string
            eventType:
              type: string
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
    DeleteApiSymV2Webhooks3Response:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
    PutApiSymV2Webhooks3Request:
      type: object
      properties:
        url:
          type: string
    PutApiSymV2Webhooks3Response:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            id:
              type: integer
            url:
              type: string
            status:
              type: string
            eventType:
              type: string
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
    GetApiSymV2V2IdResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              url:
                type: string
              status:
                type: string
              eventType:
                type: string
              createdAt:
                type: string
                format: date-time
              updatedAt:
                type: string
                format: date-time
    GetCampaignsCampaignidResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          description: Campaign data returned by the API.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
security:
- apiKey: []
tags:
- name: Api
- name: Campaigns