Skip to content

Bagel Api (1.0.0)

Bagel API docs

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://developers.bagel.ai
E-mail
support@getbagel.com
License
MIT
Languages
Servers
https://api.bagel.ai

Export API

Export ideas / evidence

Operations

Sync API

Sync feedback items into Bagel

Operations

Send feedback to Bagel

Request

Receive a batch of original feedback items from an external integration and store them as original items in Bagel. Each item must have an originId, linkedAccountId, and createdAt. The accountId is taken from the API token. The origin system is automatically set to 'api'.

Security
ApiToken
Bodyapplication/jsonrequired
feedbackNamestringrequired

Name identifier for the feedback type

Example: "gong_feature_request"
feedbackCategorystringrequired

The feedback category

Enum"call""ticket""survey""chat""lostReason""note""request""meetingInterview""other"
Example: "call"
originSystemstringrequired

The origin system where the feedback items come from

Example: "gong"
recordsArray of objectsrequired
Example: [{"originId":"gong-call-123","linkedAccountId":"sf-account-456","createdAt":"2024-01-15T10:30:00.000Z","submitterEmail":"sales@company.com","title":"Feature request from Q4 review","description":"Customer wants better integration with their CRM","priority":"high"},{"originId":"gong-call-124","linkedAccountId":"sf-account-789","createdAt":"2024-01-16T14:00:00.000Z","title":"API enhancement request","description":"Customer needs webhook support"}]
records[].​originIdstringrequired

The ID of the original item in the system of origin (e.g., Gong call ID, Survey response ID)

Example: "gong-call-123"
records[].​linkedAccountIdstringrequired

CRM ID of the relevant customer to this evidence/request

Example: "sf-account-456"
records[].​createdAtstring(date-time)required

The date the evidence was created/submitted (e.g., Call date, survey response date)

Example: "2024-01-15T10:30:00.000Z"
records[].​submitterEmailstring(email)

If applicable, the email of the internal employee who submitted this evidence

Example: "john.doe@company.com"
records[].​titlestring

Optional title for the feedback item

Example: "Feature request from customer call"
records[].​descriptionstring

Optional description of the feedback

Example: "Customer requested advanced reporting capabilities during the sales call"
records[].​productComponentstring

Optional product component related to this feedback

Example: "reporting-module"
records[].​prioritystring

Optional priority level

Example: "high"
curl -i -X POST \
  https://api.bagel.ai/sync/feedback \
  -H 'Content-Type: application/json' \
  -H 'authorization: YOUR_API_KEY_HERE' \
  -d '{
    "feedbackName": "gong_feature_request",
    "feedbackCategory": "call",
    "originSystem": "gong",
    "records": [
      {
        "originId": "gong-call-123",
        "linkedAccountId": "sf-account-456",
        "createdAt": "2024-01-15T10:30:00.000Z",
        "submitterEmail": "sales@company.com",
        "title": "Feature request from Q4 review",
        "description": "Customer wants better integration with their CRM",
        "priority": "high"
      },
      {
        "originId": "gong-call-124",
        "linkedAccountId": "sf-account-789",
        "createdAt": "2024-01-16T14:00:00.000Z",
        "title": "API enhancement request",
        "description": "Customer needs webhook support"
      }
    ]
  }'

Responses

Feedback items processed successfully

Bodyapplication/json
receivedCountinteger
filteredCountinteger
insertedCountinteger
skippedCountinteger
errorsArray of objects
Response
application/json
{
  "receivedCount": 2,
  "filteredCount": 2,
  "insertedCount": 2,
  "skippedCount": 0,
  "errors": []
}