# Corpus

> Leggere il corpus e il workspace. 22 tool, con i loro parametri ed esempi di chiamata.

Source: https://piqline.com/it/docs/api/reference/corpus

Tool dell'agente Piqline. Leggono ciò che il workspace ha già raccolto: nessun credito consumato, nulla viene scritto.

Ogni chiamata è una richiesta `POST` con la chiave in `Authorization: Bearer`. Il corpo JSON è l'input del tool, e la risposta ha la forma `{ "tool": "nom", "output": … }`. Gli esempi contengono solo i parametri obbligatori. Le descrizioni dei parametri sono quelle che leggono gli agenti.

### `getCoverageStats`

Volumi e stato della raccolta: totali, suddivisione per piattaforma e per tipo, serie di acquisizione sulla finestra di analisi (`1h`, `24h`, `7d` o `30d`).

`POST https://piqline.com/api/v1/tools/getCoverageStats`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `period` | `1h \| 24h \| 7d \| 30d` | No | Analysis window |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/getCoverageStats \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/getCoverageStats", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/getCoverageStats",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `listSources`

Fonti seguite dal workspace, con numero di elementi, stato e ultima lettura.

`POST https://piqline.com/api/v1/tools/listSources`

Tipo: Lettura. Scope: `read`.

Questo tool non ha parametri: invia un corpo vuoto, `{}`.

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listSources \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listSources", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listSources",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `searchItems`

Cerca elementi (post, video, articoli, inserzioni, offerte di lavoro) con filtri: testo, piattaforma, tipo, fonte. Senza filtro, restituisce i più recenti (al massimo 40).

`POST https://piqline.com/api/v1/tools/searchItems`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `query` | `string` | No | Free-text match on title and body |
| `platform` | `string` | No |  |
| `itemType` | `post \| video \| article \| listing \| job_offer` | No |  |
| `sourceId` | `string` | No |  |
| `limit` | `integer` | No |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/searchItems \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/searchItems", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/searchItems",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `getItem`

Dettaglio di un elemento: testo, trascrizione, OCR, argomenti rilevati, elementi vicini per significato e date di osservazione.

`POST https://piqline.com/api/v1/tools/getItem`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `itemId` | `string` | Sì |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/getItem \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/getItem", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/getItem",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
    },
)
output = response.json()["output"]
```

### `searchPassages`

Ricerca per significato nei documenti lunghi (PDF letti dal Motor): i passaggi più vicini a una domanda, con l'elemento, la pagina e il titolo della sezione.

`POST https://piqline.com/api/v1/tools/searchPassages`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `query` | `string` | Sì | Question or phrase to look for |
| `itemId` | `string` | No | Limit to one document |
| `limit` | `integer` | No |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/searchPassages \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"levée de fonds"}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/searchPassages", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "query": "levée de fonds"
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/searchPassages",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "query": "levée de fonds",
    },
)
output = response.json()["output"]
```

### `citeItem`

Verifica che un passaggio compaia parola per parola in un elemento e restituisce un numero di citazione; altrimenti il passaggio più vicino. Base della modalità Citazioni della chat.

`POST https://piqline.com/api/v1/tools/citeItem`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `itemId` | `string` | Sì | Item id from searchItems or getItem |
| `quote` | `string` | Sì | Exact passage copied from the item text |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/citeItem \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","quote":"texte"}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/citeItem", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
    "quote": "texte"
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/citeItem",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "itemId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
        "quote": "texte",
    },
)
output = response.json()["output"]
```

### `drawDiagram`

Disegna la risposta come diagramma SVG (timeline, matrice, flusso, albero…): colori per ruolo del tema, SVG ripulito prima della visualizzazione. Base della modalità Diagramma della chat.

`POST https://piqline.com/api/v1/tools/drawDiagram`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `type` | `architecture \| flowchart \| sequence \| state \| timeline \| swimlane \| quadrant \| tree \| …` | Sì | Visual type chosen for the layout |
| `title` | `string` | Sì | Short name of the subject, in the user's language |
| `description` | `string` | Sì | One sentence on what the diagram shows, for screen readers and the caption |
| `svg` | `string` | Sì | A single <svg viewBox="0 0 960 H">…</svg> following the diagram rules |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/drawDiagram \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"architecture","title":"texte","description":"texte","svg":"texte"}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/drawDiagram", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "type": "architecture",
    "title": "texte",
    "description": "texte",
    "svg": "texte"
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/drawDiagram",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "type": "architecture",
        "title": "texte",
        "description": "texte",
        "svg": "texte",
    },
)
output = response.json()["output"]
```

### `createCanvas`

Compila un canvas (un file TSX che importa solo l'SDK piqline/canvas) e restituisce il codice pronto da visualizzare, oppure l'errore da correggere. Base delle modalità Canvas e Report della chat.

`POST https://piqline.com/api/v1/tools/createCanvas`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `title` | `string` | Sì | Short title shown above the canvas, in French |
| `source` | `string` | Sì | Full .canvas.tsx source |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/createCanvas \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"texte","source":"texte"}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/createCanvas", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "title": "texte",
    "source": "texte"
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/createCanvas",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "title": "texte",
        "source": "texte",
    },
)
output = response.json()["output"]
```

### `getTopics`

Argomenti rilevati con la loro quota di voce e le storie (lo stesso soggetto visto in più fonti).

`POST https://piqline.com/api/v1/tools/getTopics`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `period` | `1h \| 24h \| 7d \| 30d` | No | Analysis window |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/getTopics \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/getTopics", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/getTopics",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `getSignals`

Segnali aperti, attivati dalle regole di persistenza del workspace, con il loro anticipo e il loro stato.

`POST https://piqline.com/api/v1/tools/getSignals`

Tipo: Lettura. Scope: `read`.

Questo tool non ha parametri: invia un corpo vuoto, `{}`.

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/getSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/getSignals", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/getSignals",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `listWorkspaceTables`

Tabelle già create nel workspace: nome, commento, numero di colonne e di righe, e se la tabella si popola da sola.

`POST https://piqline.com/api/v1/tools/listWorkspaceTables`

Tipo: Lettura. Scope: `read`.

Questo tool non ha parametri: invia un corpo vuoto, `{}`.

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listWorkspaceTables \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listWorkspaceTables", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listWorkspaceTables",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `getWorkspaceTable`

Una tabella del workspace in JSON: schema, colonne e righe. Serve da base o da feed per un sito, un'app o un agente (scope read).

`POST https://piqline.com/api/v1/tools/getWorkspaceTable`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `schema` | `string` | No | Schema, default public. |
| `name` | `string` | Sì | Table name. |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/getWorkspaceTable \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte"}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/getWorkspaceTable", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "texte"
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/getWorkspaceTable",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "name": "texte",
    },
)
output = response.json()["output"]
```

### `listBookmarks`

Segnalibri e cartelle del vault del workspace: titolo, tipo, cartella, stato, ammissione. Filtro facoltativo per parola, stato o tipo.

`POST https://piqline.com/api/v1/tools/listBookmarks`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `query` | `string` | No | Optional filter on title, note or tags. |
| `status` | `inbox \| reading \| done` | No |  |
| `kind` | `item \| source \| signal \| graph \| search \| document \| board \| chat` | No |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listBookmarks \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listBookmarks", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listBookmarks",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `listEntities`

Entità seguite (aziende, marchi, account pubblici) ed elementi collegati nel periodo.

`POST https://piqline.com/api/v1/tools/listEntities`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `period` | `7d \| 30d \| 90d` | No |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listEntities \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listEntities", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listEntities",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `listWatchContracts`

Contratti di monitoraggio impostati sulle fonti: intento, termini mantenuti ed esclusi, evento.

`POST https://piqline.com/api/v1/tools/listWatchContracts`

Tipo: Lettura. Scope: `read`.

Questo tool non ha parametri: invia un corpo vuoto, `{}`.

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listWatchContracts \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listWatchContracts", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listWatchContracts",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `checkInvestigation`

Stato dell'ultima indagine Edge, o di una indagine specifica: in attesa, in corso, conclusa con i suoi candidati, oppure fallita.

`POST https://piqline.com/api/v1/tools/checkInvestigation`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `missionId` | `string` | No | Omit to read the latest investigator mission of this workspace |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/checkInvestigation \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/checkInvestigation", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/checkInvestigation",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `checkHunt`

Stato dell'ultima ricerca, o di una ricerca specifica: fase, persone trovate con il verdetto del codice e il tuo, e per ogni criterio il suo stato e la sua prova pubblica datata (URL, data, estratto). Mai recapiti.

`POST https://piqline.com/api/v1/tools/checkHunt`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `missionId` | `string` | No | Omit to read the latest hunt of this workspace. |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/checkHunt \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/checkHunt", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/checkHunt",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `planSourcePack`

Propone un insieme coerente di fonti da seguire per un obiettivo. Non crea nulla.

`POST https://piqline.com/api/v1/tools/planSourcePack`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `name` | `string` | Sì |  |
| `rationale` | `string` | Sì | Why this pack answers the goal |
| `candidates` | `array<object>` | Sì |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/planSourcePack \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte","rationale":"texte","candidates":[{"platform":"instagram","target":"texte","label":"texte","why":"texte","confidence":"high"}]}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/planSourcePack", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "texte",
    "rationale": "texte",
    "candidates": [
      {
        "platform": "instagram",
        "target": "texte",
        "label": "texte",
        "why": "texte",
        "confidence": "high"
      }
    ]
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/planSourcePack",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "name": "texte",
        "rationale": "texte",
        "candidates": [
            {
                "platform": "instagram",
                "target": "texte",
                "label": "texte",
                "why": "texte",
                "confidence": "high",
            },
        ],
    },
)
output = response.json()["output"]
```

### `listWidgets`

Widget che possono andare su una board di questo workspace, ordinati per la persona, con le loro motivazioni.

`POST https://piqline.com/api/v1/tools/listWidgets`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `period` | `7d \| 30d \| 90d` | No | Window used by isProposable. Default 7d. |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listWidgets \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listWidgets", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listWidgets",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `getAdvertiserCampaigns`

Scheda delle inserzioni di un inserzionista dalle raccolte del workspace: inserzioni, quelle attive, date, librerie, paesi, esigenze lette, nuove inserzioni al mese e aumenti di ritmo, ultime inserzioni, segnali. Mai una persona. Nessun credito.

`POST https://piqline.com/api/v1/tools/getAdvertiserCampaigns`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `advertiser` | `string` | Sì | Name (or part of it) of the advertiser. |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/getAdvertiserCampaigns \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertiser":"texte"}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/getAdvertiserCampaigns", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "advertiser": "texte"
  }),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/getAdvertiserCampaigns",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={
        "advertiser": "texte",
    },
)
output = response.json()["output"]
```

### `listAdSignals`

Segnali pubblicitari del workspace, calcolati ogni ora: campagna avviata o interrotta, aumento di ritmo, nuovo paese, nuova piattaforma, assunzione a pagamento, promozione, lancio, nuovo inserzionista. Nessun credito.

`POST https://piqline.com/api/v1/tools/listAdSignals`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `kind` | `ad_campaign_started \| ad_campaign_stopped \| ad_ramp_up \| ad_new_country \| ad_new_platform \| ad_hiring \| ad_promotion \| ad_launch \| …` | No | ad_hiring for paid recruitment campaigns, ad_campaign_started for new campaigns, etc. |
| `activeOnly` | `boolean` | No |  |
| `limit` | `integer` | No |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listAdSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listAdSignals", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listAdSignals",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```

### `listCollectedAds`

Raccolte di inserzioni del workspace (Meta, TikTok, Google, LinkedIn), già lette: l'elenco oppure, con il nome di una raccolta, le sue suddivisioni (angoli, offerte, toni, formati), il suo ritmo, le sue inserzioni più longeve e le sue inserzioni filtrate per libreria, stato, angolo o parola. Nessun credito.

`POST https://piqline.com/api/v1/tools/listCollectedAds`

Tipo: Lettura. Scope: `read`.

| Parametro | Tipo | Obbligatorio | Descrizione |
| --- | --- | --- | --- |
| `collection` | `string` | No | Name of a collection (exact, start or fragment). |
| `library` | `meta \| tiktok \| google \| linkedin` | No |  |
| `status` | `live \| new` | No | live: active or shown within 14 days. new: first seen at the last pass. |
| `angle` | `promotion \| lancement \| marque \| preuve_sociale \| education \| recrutement \| evenement \| lead \| …` | No |  |
| `query` | `string` | No | Word to find in the advertiser, title, text, button or transcript. |
| `limit` | `integer` | No |  |

```bash tab="curl"
curl -s https://piqline.com/api/v1/tools/listCollectedAds \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```
```javascript tab="JavaScript"
const response = await fetch("https://piqline.com/api/v1/tools/listCollectedAds", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const { output } = await response.json();
```
```python tab="Python"
import os
import requests

response = requests.post(
    "https://piqline.com/api/v1/tools/listCollectedAds",
    headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
    json={},
)
output = response.json()["output"]
```
