Skip to content

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"
stateArray of strings

Filter ideas by state. Defaults to ["active"] when omitted.

Items Enum:"active""generated""deleted"
Example:
[
  "active",
  "generated"
]
POST
/export/ideas
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",
    "state": [
      "active",
      "generated"
    ]
  }'

Responses

A list of ideas

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