Integration API

Catalog

Discover brands, query sets, and published runs for the authenticated company. Paths are relative to https://api.symios.ai/v2/integration.

List Brands

Endpoint

GET /brands/list

Query string parameters

None

Return

[
    {
        "id": 12,
        "name": "Acme"
    },
    {
        "id": 15,
        "name": "RivalCo"
    }
]

Example

curl -sS "https://api.symios.ai/v2/integration/brands/list" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

List Query Sets

Endpoint

GET /sets/brands/{brandId}/list

Query string parameters

None

Return

[
    {
        "id": 42,
        "name": "Italy Q4",
        "created_at": "2026-03-01T10:00:00+00:00"
    },
    {
        "id": 57,
        "name": "Core product set",
        "created_at": "2026-06-15T14:22:00+00:00"
    }
]

Example

curl -sS "https://api.symios.ai/v2/integration/sets/brands/12/list" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

Query Set Details

Endpoint

GET /sets/{querySetId}/details

Query string parameters

None

Return

{
    "query_set_id": 42,
    "query_set_name": "Italy Q4",
    "display_name": "Sep 2026",
    "created_at": "2026-09-01T08:30:00+00:00",
    "queries_count": 150,
    "engines": [
        {
            "id": 3,
            "name": "ChatGPT",
            "image": "https://cdn.example/llm/chatgpt.png",
            "ai_model_name": "gpt-4o"
        },
        {
            "id": 7,
            "name": "Gemini",
            "image": "https://cdn.example/llm/gemini.png",
            "ai_model_name": "gemini-2.0"
        }
    ],
    "date": "01/09/2026"
}

Example

curl -sS "https://api.symios.ai/v2/integration/sets/42/details" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"

Published Runs

Endpoint

GET /sets/{querySetId}/runs

Query string parameters

None

Return

[
    {
        "id": 104,
        "display_name": "Sep 2026",
        "created_at": "2026-09-01T08:30:00+00:00"
    },
    {
        "id": 98,
        "display_name": "Aug 2026",
        "created_at": "2026-08-01T09:00:00+00:00"
    }
]

Example

curl -sS "https://api.symios.ai/v2/integration/sets/42/runs" \
  -H "X-Api-Key: sk_live_YOUR_KEY" \
  -H "X-Api-Secret: YOUR_SECRET"