# playbooks.thread_get

Playbook de uma conversa. `threadId` é o id da conversa da caixa de entrada. Devolve o playbook da conversa (`source: thread`, escolhido nela, com `progress`: etapa atual e perguntas já marcadas) ou, sem escolha, o do pipeline da oportunidade aberta do contato (`source: pipeline`, `progress` nulo) quando tem o escopo `livechat`. Sem nenhum, `playbook` vem nulo.

- Endpoint: `POST https://app.atomiks.com.br/api/v1/playbooks.thread_get` (corpo JSON)
- Quem pode chamar: membro da conta
- Escopo da chave: `messages:read`
- Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP: `playbooks_thread_get`
- Ficha em JSON: `https://app.atomiks.com.br/api/v1/openapi.json` (operationId `playbooks.thread_get`)

## Entrada

| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
| `threadId` | string (uuid) | sim |  |

<details><summary>JSON Schema</summary>

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "threadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "threadId"
  ]
}
```

</details>

## Exemplo

```bash
curl -X POST https://app.atomiks.com.br/api/v1/playbooks.thread_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"threadId":"00000000-0000-0000-0000-000000000000"}'
```

CLI:

```bash
node cli/atomiks.mjs playbooks.thread_get --json '{"threadId":"00000000-0000-0000-0000-000000000000"}'
```

MCP: ferramenta `playbooks_thread_get` com a mesma entrada.

## Saída

Sucesso: `{"data": ...}` com o formato abaixo.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "playbook": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "scopes": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "meeting",
                  "whatsapp",
                  "livechat",
                  "flows"
                ]
              }
            },
            "stages": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80
                  },
                  "key": {
                    "type": "string",
                    "maxLength": 40,
                    "pattern": "^[a-z0-9_-]*$"
                  },
                  "title": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 120
                  },
                  "objective": {
                    "default": "",
                    "type": "string",
                    "maxLength": 600
                  },
                  "talkTrack": {
                    "default": "",
                    "type": "string",
                    "maxLength": 6000
                  },
                  "watchOut": {
                    "default": "",
                    "type": "string",
                    "maxLength": 600
                  },
                  "questions": {
                    "default": [],
                    "maxItems": 30,
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 80
                        },
                        "text": {
                          "type": "string",
                          "maxLength": 300
                        }
                      },
                      "required": [
                        "id",
                        "text"
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "required": [
                  "id",
                  "title",
                  "objective",
                  "talkTrack",
                  "watchOut",
                  "questions"
                ],
                "additionalProperties": false
              }
            },
            "tones": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "when": {
                    "type": "string"
                  },
                  "delivery": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "when",
                  "delivery"
                ],
                "additionalProperties": false
              }
            },
            "keywords": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "terms": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "title": {
                    "type": "string"
                  },
                  "text": {
                    "type": "string"
                  },
                  "tone": {
                    "type": "string",
                    "enum": [
                      "info",
                      "warning",
                      "urgent"
                    ]
                  }
                },
                "required": [
                  "id",
                  "terms",
                  "title",
                  "text",
                  "tone"
                ],
                "additionalProperties": false
              }
            },
            "attachments": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "url": {
                    "type": "string"
                  },
                  "mimeType": {
                    "type": "string"
                  },
                  "size": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "url",
                  "mimeType",
                  "size"
                ],
                "additionalProperties": false
              }
            },
            "guardrails": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "createdAt": {
              "type": "string"
            },
            "updatedAt": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "description",
            "scopes",
            "stages",
            "tones",
            "keywords",
            "attachments",
            "guardrails",
            "createdAt",
            "updatedAt"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "progress": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "stageId": {
              "type": [
                "string",
                "null"
              ]
            },
            "coveredQuestionIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "stageId",
            "coveredQuestionIds"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "source": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "thread",
            "pipeline"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "playbook",
    "progress",
    "source"
  ],
  "additionalProperties": false
}
```

## Erros

`{"error": {"code", "message", "requestId"}}`. Códigos: `invalid_input` (400), `unauthorized` (401), `forbidden` / `account_pending` / `scope_missing` (403), `not_found` (404), `limit_reached` (409), `internal` (500).