PATCH
/
v0
/
streams
/
{stream}
curl --request PATCH \
  --url https://api.exa.ai/websets/v0/streams/{stream} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "status": "open",
  "metadata": {}
}'
{
  "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"
}

Authorizations

x-api-key
string
header
required

Your Exa API key

Path Parameters

stream
string
required

The id of the Stream

Body

application/json

Response

200 - application/json

Stream updated successfully

The response is of type object.