# Conversations

The Conversations endpoints let you ingest, manage, and monitor Conversations in GitBook to be processed by Docs Agents.

## The ConversationsIssuesCluster object

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"components":{"schemas":{"ConversationsIssuesCluster":{"type":"object","properties":{"object":{"type":"string","enum":["issues-cluster"]},"id":{"type":"string","description":"The ID of the conversations issues cluster"},"label":{"type":"string","description":"The label of the conversations issues cluster"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"icon":{"$ref":"#/components/schemas/Icon"},"summary":{"type":"string","description":"The summary of the conversations issues cluster"},"weeklyPulse":{"type":"array","minItems":13,"maxItems":13,"description":"The weekly pulse of the conversations issues cluster for the past 3 months","items":{"type":"number"}},"sources":{"type":"object","additionalProperties":{"type":"number","description":"The number of issues in the conversations issues cluster for the source"}},"stats":{"type":"object","description":"The stats of the conversations issues cluster","properties":{"issues":{"type":"number","description":"The number of issues in the conversations issues cluster"},"conversations":{"type":"number","description":"The number of conversations in the conversations issues cluster"},"tasksTotal":{"type":"number","description":"The number of tasks in the conversations issues cluster"},"tasksBacklog":{"type":"number","description":"The number of tasks in the backlog in the conversations issues cluster"},"tasksStarted":{"type":"number","description":"The number of tasks done in the conversations issues cluster"},"tasksCompleted":{"type":"number","description":"The number of tasks completed in the conversations issues cluster"},"tasksCancelled":{"type":"number","description":"The number of tasks canceled in the conversations issues cluster"}},"required":["issues","conversations","tasksTotal","tasksBacklog","tasksStarted","tasksCompleted","tasksCancelled"]},"urls":{"type":"object","description":"URLs associated with the conversations issues cluster","properties":{"location":{"type":"string","description":"URL of the conversations issues cluster in the API","format":"uri"},"app":{"type":"string","description":"URL of the conversations issues cluster in the application","format":"uri"}},"required":["app","location"]}},"required":["object","id","label","summary","icon","sources","stats","weeklyPulse","createdAt","updatedAt","urls"]},"Timestamp":{"type":"string","format":"date-time"},"Icon":{"type":"string","maxLength":50,"format":"icon","description":"Name of the icon"}}}}
```

## POST /orgs/{organizationId}/conversations

> Ingest conversations

```json
{"openapi":"3.0.3","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"conversations","description":"The Conversations endpoints let you ingest, manage, and monitor Conversations in GitBook to be processed by Docs Agents.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"ConversationsIssuesCluster\" grouped=\"false\" %}\n    The ConversationsIssuesCluster object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"integration-installation":[]}],"components":{"securitySchemes":{"integration-installation":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"type":"string"}}},"schemas":{"ConversationInput":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255,"description":"The unique identifier for the conversation, relative to the source in which it was created."},"metadata":{"$ref":"#/components/schemas/ConversationMetadata"},"subject":{"type":"string","maxLength":512,"description":"The subject of the conversation."},"parts":{"type":"array","items":{"$ref":"#/components/schemas/ConversationPart"}}},"required":["id","parts"]},"ConversationMetadata":{"type":"object","properties":{"url":{"type":"string","description":"URL to the conversation"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"createdAt":{"description":"Date of the conversation creation","$ref":"#/components/schemas/Timestamp"}}},"Timestamp":{"type":"string","format":"date-time"},"ConversationPart":{"oneOf":[{"$ref":"#/components/schemas/ConversationPartMessage"}]},"ConversationPartMessage":{"type":"object","description":"A message posted in the conversation by a user or a team member.","properties":{"type":{"type":"string","enum":["message"]},"role":{"type":"string","enum":["user","assistant","team-member"]},"body":{"type":"string","description":"Markdown or HTML body of the message."}},"required":["type","role","body"]}}},"paths":{"/orgs/{organizationId}/conversations":{"post":{"operationId":"ingestConversation","summary":"Ingest conversations","tags":["conversations"],"parameters":[{"$ref":"#/components/parameters/organizationId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ConversationInput"},{"type":"array","items":{"$ref":"#/components/schemas/ConversationInput"}}]}}}},"responses":{"204":{"description":"Conversations ingested"}}}}}}
```
