Skip to content
Documentation

Run Feed

POST
/api/v1/workspaces/{workspace_id}/feeds/{id}/run
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/feeds/1/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "parameters": { "additionalProperty": "example" } }'

Runs a feed.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

id
required
integer

Feed ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
parameters
object
key
additional properties
string
Examplegenerated
{
  "parameters": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
body
required
object
key
additional properties
any
status
required
integer
error
required
string
nullable
url
required
string
extracted_data
object
key
additional properties
string
Example
{
  "status": "200",
  "error": "Internal server error",
  "url": "https://example.com"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}