Streams
List Streams
Lists all streams for the Webset.
GET
/
v0
/
streams
curl --request GET \
--url https://api.exa.ai/websets/v0/streams \
--header 'x-api-key: <api-key>'
{
"data": [
{
"id": "<string>",
"object": "stream",
"status": "open",
"websetId": "<string>",
"cadence": {
"frequency": "daily",
"timezone": "Etc/UTC",
"time": "<string>"
},
"behavior": {
"type": "search",
"config": {
"parameters": {
"query": "<string>",
"criteria": [
{
"description": "<string>"
}
],
"entity": {
"type": "company"
},
"count": 123,
"behavior": "append"
}
}
},
"lastRun": {
"id": "<string>",
"object": "stream_run",
"status": "created",
"streamId": "<string>",
"type": "search",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"nextRunAt": "2023-11-07T05:31:56Z",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"hasMore": true,
"nextCursor": "<string>"
}
Authorizations
Your Exa API key
Query Parameters
The cursor to paginate through the results
Minimum length:
1
The number of results to return
Required range:
1 <= x <= 200
The id of the Webset to list streams for
Response
200 - application/json
List of streams
The response is of type object
.
curl --request GET \
--url https://api.exa.ai/websets/v0/streams \
--header 'x-api-key: <api-key>'
{
"data": [
{
"id": "<string>",
"object": "stream",
"status": "open",
"websetId": "<string>",
"cadence": {
"frequency": "daily",
"timezone": "Etc/UTC",
"time": "<string>"
},
"behavior": {
"type": "search",
"config": {
"parameters": {
"query": "<string>",
"criteria": [
{
"description": "<string>"
}
],
"entity": {
"type": "company"
},
"count": 123,
"behavior": "append"
}
}
},
"lastRun": {
"id": "<string>",
"object": "stream_run",
"status": "created",
"streamId": "<string>",
"type": "search",
"completedAt": "2023-11-07T05:31:56Z",
"failedAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"nextRunAt": "2023-11-07T05:31:56Z",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"hasMore": true,
"nextCursor": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.