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

Export ideas

Request

Export ideas based on date range.

Security
ApiToken
Bodyapplication/jsonrequired
createdAtStartstring(date-time)

ISO 8601 date string.

Example: "2024-12-01T00:00:00.000Z"
createdAtEndstring(date-time)

ISO 8601 date string.

Example: "2024-12-26T00:00:00.000Z"
curl -i -X POST \
  https://api.bagel.ai/export/ideas \
  -H 'Content-Type: application/json' \
  -H 'authorization: YOUR_API_KEY_HERE' \
  -d '{
    "createdAtStart": "2024-12-01T00:00:00.000Z",
    "createdAtEnd": "2024-12-26T00:00:00.000Z"
  }'

Responses

A list of ideas

Bodyapplication/json
ideasArray of objects(ApiIdea)
Response
application/json
{
  "ideas": [
    { … }
  ]
}

Export evidence

Request

Exports evidence based on date range.

Security
ApiToken
Bodyapplication/jsonrequired
createdAtStartstring(date-time)

ISO 8601 date string.

Example: "2024-12-01T00:00:00.000Z"
createdAtEndstring(date-time)

ISO 8601 date string.

Example: "2024-12-26T00:00:00.000Z"
curl -i -X POST \
  https://api.bagel.ai/export/evidences \
  -H 'Content-Type: application/json' \
  -H 'authorization: YOUR_API_KEY_HERE' \
  -d '{
    "createdAtStart": "2024-12-01T00:00:00.000Z",
    "createdAtEnd": "2024-12-26T00:00:00.000Z"
  }'

Responses

A list of evidence

Bodyapplication/json
evidencesArray of objects(ApiEvidence)
Response
application/json
{
  "evidences": [
    { … }
  ]
}

Sync API

Sync feedback items into Bagel

Operations