{"openapi":"3.0.0","paths":{"/v2/agents":{"get":{"description":"List all web scraping, crawling and change detection agents in your account.","operationId":"AgentsController_getAgents","parameters":[{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Agents"]},"post":{"description":"Create a new web scraping agent with CSS selectors. Pass `start=1` to run it right away.","operationId":"AgentsController_createAgent","parameters":[{"name":"start","required":false,"in":"query","description":"To auto-start the agent after creation","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Product scraper","type":"scraping","config":{"url":"https://example.com","collections":[{"name":"Products","fields":[{"name":"title","type":"CSS","selector":"h1","extract":"TEXT"},{"name":"price","type":"CSS","selector":".price","extract":"TEXT"}]}]}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentDto_Output"}}}}},"summary":"","tags":["Agents"]},"delete":{"description":"Delete one or more agents by Ids.","operationId":"AgentsController_deleteManyAgents","parameters":[{"name":"agent_id","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message_Output"}}}}},"summary":"","tags":["Agents"]}},"/v2/agents/{agent_id}":{"get":{"description":"Get a web scraping agent configuration by Id.","operationId":"AgentsController_getAgentById","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentDto_Output"}}}}},"summary":"","tags":["Agents"]},"put":{"description":"Update a web scraping agent configuration, fields and browser settings.","operationId":"AgentsController_updateAgent","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Product scraper","type":"scraping","config":{"url":"https://example.com","collections":[{"name":"Products","fields":[{"name":"title","type":"CSS","selector":"h1","extract":"TEXT"},{"name":"price","type":"CSS","selector":".price","extract":"TEXT"}]}]}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentDto_Output"}}}}},"summary":"","tags":["Agents"]},"patch":{"description":"Update an agent name, description and tags.","operationId":"AgentsController_patch","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Product scraper","description":"Scrape product title and price","tags":["ecommerce"]}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentDto_Output"}}}}},"summary":"","tags":["Agents"]},"delete":{"description":"Delete a web scraping agent by Id.","operationId":"AgentsController_deleteAgent","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message_Output"}}}}},"summary":"","tags":["Agents"]}},"/v2/agents/{agent_id}/copy":{"post":{"description":"Clone an existing agent with a new name.","operationId":"AgentsController_cloneAgent","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Product scraper (copy)"}}}}},"responses":{"200":{"description":""}},"summary":"","tags":["Agents"]}},"/v2/agents/{agent_id}/transfer":{"put":{"description":"Transfer an agent to another Agenty account by email.","operationId":"AgentsController_transferAgent","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"email":"user@example.com"}}}}},"responses":{"200":{"description":""}},"summary":"","tags":["Agents"]}},"/v2/agents/{agent_id}/scripts":{"put":{"description":"Update the JavaScript pre and post-processing scripts of an agent.","operationId":"AgentsController_agentScripts","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"pre":{"is_enabled":false},"post":{"is_enabled":true,"code":"return data;"}}}}}},"responses":{"200":{"description":""}},"summary":"","tags":["Agents"]}},"/v2/jobs":{"get":{"description":"List all agent jobs with status, pages and run time.","operationId":"JobsController_getJobs","parameters":[{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_id","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/download":{"get":{"description":"Download the jobs history as CSV.","operationId":"JobsController_downloadJobs","parameters":[{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"agent_id","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/{job_id}":{"get":{"description":"Get a job status and details by Id.","operationId":"JobsController_getJobByJobId","parameters":[{"name":"job_id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/start":{"post":{"description":"Run a web scraping agent in the cloud and get a job Id to track it.","operationId":"JobsController_startJob","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"agent_id":"abcd123456"}}}}},"responses":{"201":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/{job_id}/stop":{"get":{"description":"Stop a running job by Id.","operationId":"JobsController_stopJob","parameters":[{"name":"job_id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/{job_id}/result":{"get":{"description":"Get the scraped data of a job in JSON.","operationId":"JobsController_getJobResult","parameters":[{"name":"job_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection","required":false,"in":"query","schema":{"default":1,"type":"number"}},{"name":"format","required":false,"in":"query","description":"Applicable on download request only. Must be CSV, TSV or JSON","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/{job_id}/result/download":{"get":{"description":"Download the scraped data of a job as a file.","operationId":"JobsController_downloadJobResult","parameters":[{"name":"job_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection","required":false,"in":"query","schema":{"default":1,"type":"number"}},{"name":"format","required":false,"in":"query","description":"Applicable on download request only. Must be CSV, TSV or JSON","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/{job_id}/logs":{"get":{"description":"Get the execution logs of a job for debugging.","operationId":"JobsController_getJobLogs","parameters":[{"name":"job_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/jobs/{job_id}/files":{"get":{"description":"Download output files such as screenshots and PDFs generated by a job.","operationId":"JobsController_getJobFiles","parameters":[{"name":"job_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"name","required":true,"in":"query","description":"Name of file to download","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/inputs/{agent_id}":{"get":{"description":"Get the input URLs or data source of an agent.","operationId":"InputController_get","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputDto_Output"}}}}},"summary":"","tags":["Inputs"]},"put":{"description":"Set agent input from URLs, manual data, a List or the output of another agent.","operationId":"InputController_put","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"type":"manual","data":["https://example.com/page-1","https://example.com/page-2"]}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputDto_Output"}}}}},"summary":"","tags":["Inputs"]}},"/v2/lists":{"post":{"description":"Create a List to store URLs or input data for agents.","operationId":"ListController_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Product URLs","description":"List of product URLs to scrape"}}}}},"responses":{"201":{"description":""}},"summary":"","tags":["Lists"]},"get":{"description":"Get all Lists in your account.","operationId":"ListController_list","parameters":[{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/lists/{list_id}":{"get":{"description":"Get a List by Id.","operationId":"ListController_get","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]},"put":{"description":"Update a List name and description.","operationId":"ListController_update","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Product URLs","description":"List of product URLs to scrape"}}}}},"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/lists/{id}":{"delete":{"description":"Delete a List and all its rows.","operationId":"ListController_delete","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/lists/{list_id}/rows":{"get":{"description":"Get the rows of a List with pagination.","operationId":"ListRowsController_getListRows","parameters":[{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]},"post":{"description":"Append one or more rows to a List.","operationId":"ListRowsController_addRow","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":[{"url":"https://example.com/page-1"},{"url":"https://example.com/page-2"}]}}}},"responses":{"201":{"description":""}},"summary":"","tags":["Lists"]},"delete":{"description":"Delete multiple List rows by Ids.","operationId":"ListRowsController_deleteManyRows","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/lists/{list_id}/upload":{"post":{"description":"Import rows into a List from a CSV file.","operationId":"ListRowsController_uploadList","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"201":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/lists/{list_id}/rows/download":{"get":{"description":"Download a List as CSV.","operationId":"ListRowsController_downloadListRowById","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/lists/{list_id}/rows/{id}":{"get":{"description":"Get a single List row by Id.","operationId":"ListRowsController_getListRowById","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]},"put":{"description":"Update a single List row by Id.","operationId":"ListRowsController_updateListRowById","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"url":"https://example.com/page-1"}}}}},"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]},"delete":{"description":"Delete a single List row by Id.","operationId":"ListRowsController_deleteOneRow","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/lists/{list_id}/rows/clear":{"delete":{"description":"Remove all rows from a List.","operationId":"ListRowsController_clearListRows","parameters":[{"name":"list_id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Lists"]}},"/v2/scheduler/{agent_id}":{"get":{"description":"Get the cron schedule of an agent.","operationId":"SchedulerController_get","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerDto_Output"}}}}},"summary":"","tags":["Scheduler"]},"put":{"description":"Schedule an agent to run automatically with a cron expression.","operationId":"SchedulerController_put","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"type":"cron","expression":"0 9 * * *","description":"Every day at 9 AM"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerDto_Output"}}}}},"summary":"","tags":["Scheduler"]},"patch":{"description":"Enable or disable an agent schedule.","operationId":"SchedulerController_patch","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"is_enabled":false}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulerDto_Output"}}}}},"summary":"","tags":["Scheduler"]},"delete":{"description":"Remove the schedule of an agent.","operationId":"SchedulerController_delete","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message_Output"}}}}},"summary":"","tags":["Scheduler"]}},"/v2/workflows":{"get":{"description":"List all workflows that automate actions after agent jobs.","operationId":"WorkflowController_getWorkflows","parameters":[],"responses":{"200":{"description":""}},"summary":"","tags":["Workflows"]},"post":{"description":"Create a workflow to send scraped data to a webhook, email, Google Sheets, S3 and more.","operationId":"WorkflowController_createWorkflow","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Email on completion","agents":{"all":true},"trigger":{"when":["job_completed"]},"actions":[{"type":"webhook","config":{"url":"https://example.com/webhook"}}]}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow_Output"}}}}},"summary":"","tags":["Workflows"]}},"/v2/workflows/{id}":{"get":{"description":"Get a workflow by Id.","operationId":"WorkflowController_getWorkflowById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow_Output"}}}}},"summary":"","tags":["Workflows"]},"put":{"description":"Update a workflow trigger and actions.","operationId":"WorkflowController_updateWorkflowById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Email on completion","agents":{"all":true},"trigger":{"when":["job_completed"]},"actions":[{"type":"webhook","config":{"url":"https://example.com/webhook"}}]}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow_Output"}}}}},"summary":"","tags":["Workflows"]},"patch":{"description":"Enable or disable a workflow.","operationId":"WorkflowController_updateWorkflowStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"is_enabled":false}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableDisable_Output"}}}}},"summary":"","tags":["Workflows"]},"delete":{"description":"Delete a workflow by Id.","operationId":"WorkflowController_deleteWorkflowById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message_Output"}}}}},"summary":"","tags":["Workflows"]}},"/v2/users":{"post":{"description":"Invite a team member to your account with a role.","operationId":"UserController_post","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"John Doe","email":"john@example.com","role":"Manager","status":"active"}}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"summary":"","tags":["Users"]},"get":{"description":"List all team members in your account.","operationId":"UserController_list","parameters":[{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Users"]},"delete":{"description":"Remove one or more team members by Ids.","operationId":"UserController_delete","parameters":[{"name":"user_id","required":true,"in":"query","schema":{"type":"array","items":{"type":"number"}}}],"responses":{"200":{"description":""}},"summary":"","tags":["Users"]}},"/v2/users/{user_id}":{"get":{"description":"Get a team member by Id.","operationId":"UserController_get","parameters":[{"name":"user_id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Users"]},"put":{"description":"Update a team member role or status.","operationId":"UserController_update","parameters":[{"name":"user_id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"John Doe","email":"john@example.com","role":"Manager","status":"active"}}}}},"responses":{"200":{"description":""}},"summary":"","tags":["Users"]}},"/v2/results/{agent_id}":{"get":{"description":"Get the latest scraped data of an agent in JSON.","operationId":"ResultsController_getResult","parameters":[{"name":"agent_id","required":true,"in":"path","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"collection","required":false,"in":"query","schema":{"default":1,"type":"number"}},{"name":"format","required":false,"in":"query","description":"Applicable on download request only. Must be CSV, TSV or JSON","schema":{"type":"string"}},{"name":"download","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Jobs"]}},"/v2/connections":{"get":{"description":"List all third-party connections such as Google Sheets, Dropbox and S3.","operationId":"ConnectionsController_getConnections","parameters":[],"responses":{"200":{"description":""}},"summary":"","tags":["Connections"]}},"/v2/connections/{id}":{"patch":{"description":"Rename a third-party connection by Id.","operationId":"ConnectionsController_patch","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Google Sheets"}}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSuccess"}}}}},"summary":"","tags":["Connections"]},"delete":{"description":"Delete a third-party connection by Id.","operationId":"ConnectionsController_deleteConnection","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomSuccess"}}}}},"summary":"","tags":["Connections"]}},"/v2/connections/{id}/connect":{"get":{"operationId":"ConnectionsController_connect","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"shop","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Connections"]}},"/v2/dashboard":{"get":{"description":"Get account usage reports: pages scraped by agent, date and product.","operationId":"DashboardController_dashboard","parameters":[{"name":"start","required":false,"in":"query","description":"T-30 by default","schema":{"$ref":"#/components/schemas/Object"}},{"name":"end","required":false,"in":"query","description":"If no date provided, default is today date","schema":{"$ref":"#/components/schemas/Object"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Dashboard"]}},"/v2/projects":{"get":{"description":"List all projects used to organize agents.","operationId":"ProjectsController_getProjects","parameters":[{"name":"offset","required":false,"in":"query","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"maximum":1000,"default":1000,"type":"number"}},{"name":"sort","required":false,"in":"query","schema":{"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Projects"]},"post":{"description":"Create a project to group related agents.","operationId":"ProjectsController_createProject","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Ecommerce","description":"Agents for ecommerce websites"}}}}},"responses":{"201":{"description":""}},"summary":"","tags":["Projects"]},"delete":{"description":"Delete one or more projects by Ids.","operationId":"ProjectsController_deleteProject","parameters":[{"name":"project_id","required":true,"in":"query","schema":{"type":"array","items":{"type":"number"}}}],"responses":{"200":{"description":""}},"summary":"","tags":["Projects"]}},"/v2/projects/{id}":{"get":{"description":"Get a project and its agents by Id.","operationId":"ProjectsController_getProjectById","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Projects"]},"put":{"description":"Update a project name and description.","operationId":"ProjectsController_updateProject","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"Ecommerce","description":"Agents for ecommerce websites"}}}}},"responses":{"200":{"description":""}},"summary":"","tags":["Projects"]}},"/v2/projects/{id}/add":{"post":{"description":"Add one or more agents to a project.","operationId":"ProjectsController_addAgentsInProject","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":["abcd123456","efgh789012"]}}}},"responses":{"201":{"description":""}},"summary":"","tags":["Projects"]}},"/v2/projects/{id}/delete":{"delete":{"description":"Remove an agent from a project.","operationId":"ProjectsController_removeAgentsFromProject","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}},{"name":"agent_id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"","tags":["Projects"]}}},"info":{"title":"Web Scraping API - Agenty","description":"# Agenty API\nAgenty is a SaaS platform with easy-to-use AI agents for web scraping, crawling and online data extraction from the web. We offer 3 types of agents mainly for complete web automation - \n\n1. [Web scraping agent](https://agenty.com/products/scraping-agent): To extract data from a given URL, pagination etc.\n2. [Web crawling agent](https://agenty.com/products/crawling-agent): Rule based web crawling to crawl matching URLs intelligently\n3. [Web monitoring agent](https://agenty.com/products/change-detection-agent): Website monitoring and change detection.\n\n## Web Scraping API\n\nAgenty's web scraping API to extract data from websites, JSON, XML files automatically. Whether you're a developer looking for a free web scraping API or a business in need of a reliable data scraping solution, our API has got you covered.\n\nUsing the Agenty AI API you can start scraping jobs, add URLs, download data, inject JavaScript, allowing you to execute dynamic scraping tasks on scale.\n\nThe Agenty scrapers uses the [best proxy solutions](https://agenty.com/docs/anonymous-web-scraping-using-proxy-servers/134) tailored for web scraping, ensuring your web crawling activities remain anonymous and respectful of website policies. Our transparent pricing model allows you to choose the plan that fits your requirements, making [web scraping budget-friendly](https://agenty.com/pricing) and accessible.\n\nThe API can be used to perform various actions such as:\n- Start a scraping agent\n- Add URLs in scraping agent\n- Download the scraping output\n- Schedule a scraping job\n- Create a workflow, webhook and more...\n\nThe API documentation includes information on authentication and authorization, request and response formats with example JSON for each endpoint.\n\n\n## Endpoints\n\nThe root endpoint of Agenty API is: `https://api.agenty.com/v2` and we recommend you to fetch our API over `https`.\n\n## Authentication\n\nThe Agenty API uses **Bearer authentication**.\n\nAll requests must include your **API key** in the `Authorization: Bearer {API_KEY}` header as a Bearer token:\n\n### Getting your API key\n\nYou'd need an Agenty account. [Sign Up here](https://cloud.agenty.com/signup), if you don’t have one.\n\nOnce you are logged in, go to the Settings page and then [API keys page](https://cloud.agenty.com/settings/api-keys) to get your API key.\n\n![API keys for Agenty](https://cdn.agenty.com/img/agenty-api-key.png)\n\n","version":"2.0","contact":{}},"tags":[],"servers":[{"url":"https://api.agenty.com"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"Enter JWT token"}},"schemas":{"AgentDto_Output":{"oneOf":[{"type":"object","properties":{"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"nullable":true},"account_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"user_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"project_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1000,"nullable":true},"tags":{"default":[],"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"is_public":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_managed":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"input":{"default":{"type":"url","data":[]},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"data":{"minItems":1,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["manual"]},"data":{"minItems":1,"maxItems":50000,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","id","field"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["agent"]},"collection":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","collection","id","field"],"additionalProperties":false}]},"scripts":{"type":"object","properties":{"pre":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"}},"additionalProperties":false}]},"post":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1},"is_parallel_execution":{"type":"boolean"}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"},"is_parallel_execution":{"type":"boolean"}},"additionalProperties":false}]}},"additionalProperties":false,"nullable":true},"settings":{"type":"object","properties":{"batching_size":{"type":"number","minimum":1,"maximum":10000},"concurrency":{"type":"number","minimum":1,"maximum":100},"headless":{"type":"boolean"}},"required":["batching_size","concurrency","headless"],"additionalProperties":false,"nullable":true},"dataset_type":{"type":"string","nullable":true},"scheduler":{"type":"object","properties":{"type":{"default":"cron","type":"string","enum":["cron","interval"]},"expression":{"type":"string"},"frequency":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"is_enabled":{"default":true,"type":"boolean"}},"required":["type","expression","is_enabled"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"type":{"type":"string","enum":["scraping"]},"config":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"collections":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"fields":{"minItems":1,"maxItems":124,"type":"array","items":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["CSS"]},"selector":{"type":"string","minLength":1},"extract":{"default":"TEXT","type":"string","enum":["TEXT","HTML","ATTR","INNERHTML","OUTERTEXT"]},"attribute":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","selector","extract"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["REGEX"]},"selector":{"type":"string","minLength":1},"extract":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","selector","extract"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["JSON"]},"selector":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","selector"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["INPUT"]},"from":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","from"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["DEFAULT"]},"from":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","from"],"additionalProperties":false}]}},"query":{"type":"string","nullable":true},"model":{"type":"string","nullable":true}},"required":["name","fields"],"additionalProperties":false}},"code":{"type":"string","nullable":true},"wait_for":{"default":{"type":"selector","timeout":5000},"type":"object","properties":{"type":{"default":"selector","type":"string","enum":["selector","timeout","script"]},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true},"hidden":{"type":"boolean","nullable":true},"visible":{"type":"boolean","nullable":true},"timeout":{"default":5000,"type":"integer","minimum":0,"maximum":30000},"ignore_errors":{"type":"boolean","nullable":true}},"required":["type","timeout"],"additionalProperties":false},"pagination":{"default":{"enabled":false},"oneOf":[{"type":"object","properties":{"enabled":{"default":false,"type":"boolean","const":false}},"required":["enabled"],"additionalProperties":false},{"type":"object","properties":{"enabled":{"type":"boolean","enum":[true]},"type":{"default":"click","type":"string","enum":["click","scroll","loadmore","script"]},"value":{"type":"string","nullable":true},"container":{"type":"string","nullable":true},"max_pages":{"type":"integer","minimum":1,"maximum":100000}},"required":["enabled","type","max_pages"],"additionalProperties":false}]},"form":{"default":{"enabled":false,"actions":[]},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"actions":{"default":[],"maxItems":160,"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string","nullable":true},"target":{"type":"string","nullable":true}},"required":["type"],"additionalProperties":false}}},"required":["enabled","actions"],"additionalProperties":false},"login":{"default":{"enabled":false,"actions":[]},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"actions":{"default":[],"maxItems":160,"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string","nullable":true},"target":{"type":"string","nullable":true}},"required":["type"],"additionalProperties":false}}},"required":["enabled","actions"],"additionalProperties":false},"logout":{"default":{"enabled":false,"actions":[]},"type":"object","properties":{"enabled":{"default":false,"type":"boolean"},"actions":{"default":[],"maxItems":160,"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string","nullable":true},"target":{"type":"string","nullable":true}},"required":["type"],"additionalProperties":false}}},"required":["enabled","actions"],"additionalProperties":false},"developer_mode":{"default":false,"type":"boolean"},"go_to_options":{"default":{"timeout":30000,"wait_until":["domcontentloaded"]},"type":"object","properties":{"timeout":{"default":30000,"type":"integer","minimum":1000,"maximum":30000},"wait_until":{"default":["domcontentloaded"],"maxItems":4,"type":"array","items":{"type":"string"}},"referer":{"type":"string","nullable":true}},"required":["timeout","wait_until"],"additionalProperties":false},"browser":{"default":"default","type":"string","enum":["default","puppeteer","playwright","fetch"]},"device":{"type":"string","nullable":true},"retry":{"default":{"enabled":true,"max_try":1,"try_interval":0},"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"max_try":{"default":1,"type":"integer","minimum":0,"maximum":3},"try_interval":{"default":0,"type":"integer","minimum":0,"maximum":5000}},"required":["enabled","max_try","try_interval"],"additionalProperties":false},"viewport":{"default":{"width":1280,"height":800},"type":"object","properties":{"width":{"default":1280,"type":"number","minimum":0},"height":{"default":800,"type":"number","minimum":0}},"required":["width","height"],"additionalProperties":false},"anonymous":{"default":{"proxy":true,"proxy_type":"default","skip_resource_types":[]},"type":"object","properties":{"proxy":{"default":true,"type":"boolean"},"country":{"type":"string","nullable":true},"proxy_type":{"default":"default","type":"string"},"skip_resource_types":{"default":[],"type":"array","items":{"type":"string"}}},"required":["proxy","proxy_type","skip_resource_types"],"additionalProperties":false},"block_ads":{"default":true,"type":"boolean"},"block_trackers":{"default":true,"type":"boolean"},"lazy_load":{"default":false,"type":"boolean"},"accept_cookie_consent":{"default":true,"type":"boolean"},"set_javascript_enabled":{"default":true,"type":"boolean"},"headers":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"local_storage":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"session_storage":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"reject_resource_types":{"default":[],"type":"array","items":{"type":"string"}},"reject_request_pattern":{"default":[],"type":"array","items":{"type":"string"}}},"required":["url","collections","wait_for","pagination","form","login","logout","developer_mode","go_to_options","browser","retry","viewport","anonymous","block_ads","block_trackers","lazy_load","accept_cookie_consent","set_javascript_enabled","headers","local_storage","session_storage","reject_resource_types","reject_request_pattern"],"additionalProperties":false}},"required":["name","tags","is_public","is_managed","input","type","config"],"additionalProperties":false},{"type":"object","properties":{"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"nullable":true},"account_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"user_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"project_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1000,"nullable":true},"tags":{"default":[],"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"is_public":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_managed":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"input":{"default":{"type":"url","data":[]},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"data":{"minItems":1,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["manual"]},"data":{"minItems":1,"maxItems":50000,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","id","field"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["agent"]},"collection":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","collection","id","field"],"additionalProperties":false}]},"scripts":{"type":"object","properties":{"pre":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"}},"additionalProperties":false}]},"post":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1},"is_parallel_execution":{"type":"boolean"}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"},"is_parallel_execution":{"type":"boolean"}},"additionalProperties":false}]}},"additionalProperties":false,"nullable":true},"settings":{"type":"object","properties":{"batching_size":{"type":"number","minimum":1,"maximum":10000},"concurrency":{"type":"number","minimum":1,"maximum":100},"headless":{"type":"boolean"}},"required":["batching_size","concurrency","headless"],"additionalProperties":false,"nullable":true},"dataset_type":{"type":"string","nullable":true},"scheduler":{"type":"object","properties":{"type":{"default":"cron","type":"string","enum":["cron","interval"]},"expression":{"type":"string"},"frequency":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"is_enabled":{"default":true,"type":"boolean"}},"required":["type","expression","is_enabled"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"type":{"type":"string","enum":["crawling"]},"config":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"collections":{"minItems":1,"maxItems":12,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"fields":{"minItems":1,"maxItems":124,"type":"array","items":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["CSS"]},"selector":{"type":"string","minLength":1},"extract":{"default":"TEXT","type":"string","enum":["TEXT","HTML","ATTR","INNERHTML","OUTERTEXT"]},"attribute":{"type":"string","nullable":true},"from":{"type":"string","nullable":true},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","selector","extract"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["REGEX"]},"selector":{"type":"string","minLength":1},"extract":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","selector","extract"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["JSON"]},"selector":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","selector"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["INPUT"]},"from":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","from"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"type":{"type":"string","enum":["DEFAULT"]},"from":{"type":"string","minLength":1},"join":{"type":"boolean","nullable":true},"post_processing":{"type":"array","items":{"type":"object","properties":{"function":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["function","parameters"],"additionalProperties":false},"nullable":true}},"required":["name","type","from"],"additionalProperties":false}]}},"query":{"type":"string","nullable":true},"model":{"type":"string","nullable":true}},"required":["name","fields"],"additionalProperties":false}},"wait_for":{"default":{"type":"selector","timeout":5000},"type":"object","properties":{"type":{"default":"selector","type":"string","enum":["selector","timeout","script"]},"value":{"anyOf":[{"type":"string"},{"type":"number"}],"nullable":true},"hidden":{"type":"boolean","nullable":true},"visible":{"type":"boolean","nullable":true},"timeout":{"default":5000,"type":"integer","minimum":0,"maximum":30000},"ignore_errors":{"type":"boolean","nullable":true}},"required":["type","timeout"],"additionalProperties":false},"max_results":{"default":0,"type":"number","maximum":9999999999},"keep_cookies":{"default":false,"type":"boolean"},"follow_sitemaps":{"default":true,"type":"boolean"},"max_link_per_page":{"default":5000,"type":"number","minimum":1,"maximum":99999},"max_time_to_crawl":{"default":300,"type":"number","minimum":1,"maximum":86400},"max_depth_to_crawl":{"default":3,"type":"number","minimum":1,"maximum":999},"max_pages_to_crawl":{"default":100,"type":"number","minimum":1,"maximum":9999999999},"max_error_threshold":{"default":5,"type":"number","minimum":0,"maximum":99999},"respect_robots_txt":{"default":true,"type":"boolean"},"respect_rel_nofollow":{"default":true,"type":"boolean"},"follow_external_links":{"default":false,"type":"boolean"},"should_crawl_external_pages":{"default":false,"type":"boolean"},"should_crawl_internal_pages":{"default":true,"type":"boolean"},"crawl_rules":{"default":[],"type":"array","items":{"type":"string"}},"process_rules":{"default":[],"type":"array","items":{"type":"string"}},"priority_rules":{"default":[],"type":"array","items":{"type":"string"}},"go_to_options":{"default":{"timeout":30000,"wait_until":["domcontentloaded"]},"type":"object","properties":{"timeout":{"default":30000,"type":"integer","minimum":1000,"maximum":30000},"wait_until":{"default":["domcontentloaded"],"maxItems":4,"type":"array","items":{"type":"string"}},"referer":{"type":"string","nullable":true}},"required":["timeout","wait_until"],"additionalProperties":false},"browser":{"default":"default","type":"string","enum":["default","puppeteer","playwright","fetch"]},"device":{"type":"string","nullable":true},"retry":{"default":{"enabled":true,"max_try":1,"try_interval":0},"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"max_try":{"default":1,"type":"integer","minimum":0,"maximum":3},"try_interval":{"default":0,"type":"integer","minimum":0,"maximum":5000}},"required":["enabled","max_try","try_interval"],"additionalProperties":false},"viewport":{"default":{"width":1280,"height":800},"type":"object","properties":{"width":{"default":1280,"type":"number","minimum":0},"height":{"default":800,"type":"number","minimum":0}},"required":["width","height"],"additionalProperties":false},"anonymous":{"default":{"proxy":true,"proxy_type":"default","skip_resource_types":[]},"type":"object","properties":{"proxy":{"default":true,"type":"boolean"},"country":{"type":"string","nullable":true},"proxy_type":{"default":"default","type":"string"},"skip_resource_types":{"default":[],"type":"array","items":{"type":"string"}}},"required":["proxy","proxy_type","skip_resource_types"],"additionalProperties":false},"block_ads":{"default":true,"type":"boolean"},"block_trackers":{"default":true,"type":"boolean"},"lazy_load":{"default":false,"type":"boolean"},"accept_cookie_consent":{"default":true,"type":"boolean"},"set_javascript_enabled":{"default":true,"type":"boolean"},"headers":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"local_storage":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"session_storage":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"reject_resource_types":{"default":[],"type":"array","items":{"type":"string"}},"reject_request_pattern":{"default":[],"type":"array","items":{"type":"string"}}},"required":["url","collections","wait_for","max_results","keep_cookies","follow_sitemaps","max_link_per_page","max_time_to_crawl","max_depth_to_crawl","max_pages_to_crawl","max_error_threshold","respect_robots_txt","respect_rel_nofollow","follow_external_links","should_crawl_external_pages","should_crawl_internal_pages","crawl_rules","process_rules","priority_rules","go_to_options","browser","retry","viewport","anonymous","block_ads","block_trackers","lazy_load","accept_cookie_consent","set_javascript_enabled","headers","local_storage","session_storage","reject_resource_types","reject_request_pattern"],"additionalProperties":false}},"required":["name","tags","is_public","is_managed","input","type","config"],"additionalProperties":false},{"type":"object","properties":{"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"nullable":true},"account_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"user_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"project_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1000,"nullable":true},"tags":{"default":[],"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"is_public":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_managed":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"input":{"default":{"type":"url","data":[]},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"data":{"minItems":1,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["manual"]},"data":{"minItems":1,"maxItems":50000,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","id","field"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["agent"]},"collection":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","collection","id","field"],"additionalProperties":false}]},"scripts":{"type":"object","properties":{"pre":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"}},"additionalProperties":false}]},"post":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1},"is_parallel_execution":{"type":"boolean"}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"},"is_parallel_execution":{"type":"boolean"}},"additionalProperties":false}]}},"additionalProperties":false,"nullable":true},"settings":{"type":"object","properties":{"batching_size":{"type":"number","minimum":1,"maximum":10000},"concurrency":{"type":"number","minimum":1,"maximum":100},"headless":{"type":"boolean"}},"required":["batching_size","concurrency","headless"],"additionalProperties":false,"nullable":true},"dataset_type":{"type":"string","nullable":true},"scheduler":{"type":"object","properties":{"type":{"default":"cron","type":"string","enum":["cron","interval"]},"expression":{"type":"string"},"frequency":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"is_enabled":{"default":true,"type":"boolean"}},"required":["type","expression","is_enabled"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"type":{"type":"string","enum":["changedetection"]},"config":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"selector":{"type":"string","minLength":1},"extract":{"default":"TEXT","type":"string","enum":["TEXT","ATTR","HTML"]},"attribute":{"type":"string","nullable":true},"keywords":{"default":[],"type":"array","items":{"type":"string"},"nullable":true},"keywords_change":{"default":"added","type":"string","enum":["added","removed"],"nullable":true},"screenshot_type":{"default":"full","type":"string","enum":["visible","full"]},"emails":{"type":"string","nullable":true},"attach_screenshot":{"default":true,"type":"boolean"},"ignore_minor_changes":{"default":true,"type":"boolean"},"error_alert":{"default":true,"type":"boolean"},"go_to_options":{"default":{"timeout":30000,"wait_until":["domcontentloaded"]},"type":"object","properties":{"timeout":{"default":30000,"type":"integer","minimum":1000,"maximum":30000},"wait_until":{"default":["domcontentloaded"],"maxItems":4,"type":"array","items":{"type":"string"}},"referer":{"type":"string","nullable":true}},"required":["timeout","wait_until"],"additionalProperties":false},"browser":{"default":"default","type":"string","enum":["default","puppeteer","playwright","fetch"]},"device":{"type":"string","nullable":true},"retry":{"default":{"enabled":true,"max_try":1,"try_interval":0},"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"max_try":{"default":1,"type":"integer","minimum":0,"maximum":3},"try_interval":{"default":0,"type":"integer","minimum":0,"maximum":5000}},"required":["enabled","max_try","try_interval"],"additionalProperties":false},"viewport":{"default":{"width":1280,"height":800},"type":"object","properties":{"width":{"default":1280,"type":"number","minimum":0},"height":{"default":800,"type":"number","minimum":0}},"required":["width","height"],"additionalProperties":false},"anonymous":{"default":{"proxy":true,"proxy_type":"default","skip_resource_types":[]},"type":"object","properties":{"proxy":{"default":true,"type":"boolean"},"country":{"type":"string","nullable":true},"proxy_type":{"default":"default","type":"string"},"skip_resource_types":{"default":[],"type":"array","items":{"type":"string"}}},"required":["proxy","proxy_type","skip_resource_types"],"additionalProperties":false},"block_ads":{"default":true,"type":"boolean"},"block_trackers":{"default":true,"type":"boolean"},"lazy_load":{"default":false,"type":"boolean"},"accept_cookie_consent":{"default":true,"type":"boolean"},"set_javascript_enabled":{"default":true,"type":"boolean"},"headers":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"local_storage":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"session_storage":{"default":[],"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"reject_resource_types":{"default":[],"type":"array","items":{"type":"string"}},"reject_request_pattern":{"default":[],"type":"array","items":{"type":"string"}}},"required":["url","selector","extract","keywords","keywords_change","screenshot_type","attach_screenshot","ignore_minor_changes","error_alert","go_to_options","browser","retry","viewport","anonymous","block_ads","block_trackers","lazy_load","accept_cookie_consent","set_javascript_enabled","headers","local_storage","session_storage","reject_resource_types","reject_request_pattern"],"additionalProperties":false}},"required":["name","tags","is_public","is_managed","input","type","config"],"additionalProperties":false},{"type":"object","properties":{"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"nullable":true},"account_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"user_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"project_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1000,"nullable":true},"tags":{"default":[],"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"is_public":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_managed":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"input":{"default":{"type":"url","data":[]},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"data":{"minItems":1,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["manual"]},"data":{"minItems":1,"maxItems":50000,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","id","field"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["agent"]},"collection":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","collection","id","field"],"additionalProperties":false}]},"scripts":{"type":"object","properties":{"pre":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"}},"additionalProperties":false}]},"post":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1},"is_parallel_execution":{"type":"boolean"}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"},"is_parallel_execution":{"type":"boolean"}},"additionalProperties":false}]}},"additionalProperties":false,"nullable":true},"settings":{"type":"object","properties":{"batching_size":{"type":"number","minimum":1,"maximum":10000},"concurrency":{"type":"number","minimum":1,"maximum":100},"headless":{"type":"boolean"}},"required":["batching_size","concurrency","headless"],"additionalProperties":false,"nullable":true},"dataset_type":{"type":"string","nullable":true},"scheduler":{"type":"object","properties":{"type":{"default":"cron","type":"string","enum":["cron","interval"]},"expression":{"type":"string"},"frequency":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"is_enabled":{"default":true,"type":"boolean"}},"required":["type","expression","is_enabled"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"type":{"type":"string","enum":["mapmonitoring"]},"config":{"default":{},"type":"object","properties":{},"additionalProperties":false}},"required":["name","tags","is_public","is_managed","input","type","config"],"additionalProperties":false},{"type":"object","properties":{"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"nullable":true},"account_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"user_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"project_id":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"nullable":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1000,"nullable":true},"tags":{"default":[],"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"nullable":true},"is_public":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"is_managed":{"default":false,"anyOf":[{"type":"boolean"},{"type":"null"}]},"input":{"default":{"type":"url","data":[]},"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"data":{"minItems":1,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["manual"]},"data":{"minItems":1,"maxItems":50000,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","id","field"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["agent"]},"collection":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","collection","id","field"],"additionalProperties":false}]},"scripts":{"type":"object","properties":{"pre":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"}},"additionalProperties":false}]},"post":{"oneOf":[{"type":"object","properties":{"is_enabled":{"type":"boolean","enum":[true]},"code":{"type":"string","minLength":1},"is_parallel_execution":{"type":"boolean"}},"required":["is_enabled","code"],"additionalProperties":false},{"type":"object","properties":{"is_enabled":{"type":"boolean","const":false},"code":{"type":"string"},"is_parallel_execution":{"type":"boolean"}},"additionalProperties":false}]}},"additionalProperties":false,"nullable":true},"settings":{"type":"object","properties":{"batching_size":{"type":"number","minimum":1,"maximum":10000},"concurrency":{"type":"number","minimum":1,"maximum":100},"headless":{"type":"boolean"}},"required":["batching_size","concurrency","headless"],"additionalProperties":false,"nullable":true},"dataset_type":{"type":"string","nullable":true},"scheduler":{"type":"object","properties":{"type":{"default":"cron","type":"string","enum":["cron","interval"]},"expression":{"type":"string"},"frequency":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"is_enabled":{"default":true,"type":"boolean"}},"required":["type","expression","is_enabled"],"additionalProperties":false,"nullable":true},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"type":{"type":"string","enum":["brandmonitoring"]},"config":{"default":{},"type":"object","properties":{},"additionalProperties":false}},"required":["name","tags","is_public","is_managed","input","type","config"],"additionalProperties":false}],"id":"Agent_Output"},"Message_Output":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"id":"Message_Output","additionalProperties":false},"InputDto_Output":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["url"]},"data":{"minItems":1,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["manual"]},"data":{"minItems":1,"maxItems":50000,"type":"array","items":{"type":"string"}}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["list"]},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","id","field"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["agent"]},"collection":{"default":1,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"id":{"type":"string","minLength":1},"field":{"type":"string","minLength":1}},"required":["type","collection","id","field"],"additionalProperties":false}]},"SchedulerDto_Output":{"type":"object","properties":{"scheduler":{"type":"object","properties":{"type":{"default":"cron","type":"string","enum":["cron","interval"]},"expression":{"type":"string"},"frequency":{"type":"number","nullable":true},"description":{"type":"string","nullable":true},"is_enabled":{"default":true,"type":"boolean"}},"required":["type","expression","is_enabled"],"additionalProperties":false},"next_scheduled_run_at":{"type":"string","nullable":true},"last_scheduled_run_at":{"type":"string","nullable":true}},"required":["scheduler"],"additionalProperties":false},"Workflow_Output":{"type":"object","properties":{"workflow_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"nullable":true},"account_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"nullable":true},"user_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"nullable":true},"name":{"type":"string","minLength":1,"maxLength":64},"agents":{"type":"object","properties":{"all":{"type":"boolean"},"selected":{"type":"array","items":{"type":"string"}}},"required":["all"],"additionalProperties":false},"trigger":{"type":"object","properties":{"when":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"string","enum":["job_completed","job_error","change_detected"]}}},"required":["when"],"additionalProperties":false},"actions":{"type":"array","minItems":1,"maxItems":10,"items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["email"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"emails":{"type":"string","minLength":1},"attach_result":{"default":false,"type":"boolean"}},"required":["emails","attach_result"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["webhook"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"batch_size":{"default":1000,"type":"integer","minimum":1,"maximum":2500},"collections":{"default":"1","type":"string","pattern":"^\\d+(\\s*,\\s*\\d+)*$"}},"required":["url","batch_size","collections"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["zapier"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"batch_size":{"type":"integer","minimum":1,"maximum":2500},"collections":{"type":"string","pattern":"^\\d+(\\s*,\\s*\\d+)*$"}},"required":["url","batch_size","collections"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["google"]},"connection_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"config":{"type":"object","properties":{"sheet_id":{"type":"string","minLength":1},"range":{"type":"string"},"headers":{"type":"string","enum":["Yes","No"]},"write_mode":{"type":"string","enum":["Append","Overwrite"]}},"required":["sheet_id"],"additionalProperties":false}},"required":["type","connection_id","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["dropbox"]},"connection_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"config":{"type":"object","properties":{"path":{"type":"string","minLength":1},"collections":{"type":"string","pattern":"^\\d+(\\s*,\\s*\\d+)*$"}},"required":["path"],"additionalProperties":false}},"required":["type","connection_id","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["amazons3"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"access_key":{"type":"string","minLength":1},"secret_key":{"type":"string","minLength":1},"region":{"type":"string","minLength":1},"bucket":{"type":"string","minLength":1},"path":{"type":"string","minLength":1},"collections":{"type":"string","pattern":"^\\d+(\\s*,\\s*\\d+)*$"}},"required":["access_key","secret_key","region","bucket","path","collections"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["algolia"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"application_id":{"type":"string","minLength":1},"api_key":{"type":"string","minLength":1},"indices_name":{"type":"string","minLength":1},"url_field":{"type":"string","minLength":1},"clear_index":{"type":"boolean"}},"required":["application_id","api_key","indices_name","url_field","clear_index"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sftp"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"ftp_type":{"type":"string","enum":["FTP","FTPS","SFTP"]},"host":{"type":"string","minLength":1},"port":{"type":"integer","minimum":1,"maximum":65535},"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1},"path":{"type":"string","minLength":1},"name":{"type":"string","minLength":1}},"required":["ftp_type","host","port","username","password","path","name"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["agenty"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"agent_id":{"anyOf":[{"type":"string","minLength":1},{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}]}},"required":["agent_id"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["firebase"]},"connection_id":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"config":{"type":"object","properties":{"project_id":{"type":"string","minLength":1},"collection_name":{"type":"string","minLength":1},"key_field":{"type":"string"}},"required":["project_id","collection_name"],"additionalProperties":false}},"required":["type","connection_id","config"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["mongodb"]},"connection_id":{"type":"number","nullable":true},"config":{"type":"object","properties":{"connection_string":{"type":"string","pattern":"^mongodb(\\+srv)?:\\/\\/"},"database_name":{"type":"string","minLength":1},"collection_name":{"type":"string","minLength":1}},"required":["connection_string","database_name","collection_name"],"additionalProperties":false}},"required":["type","config"],"additionalProperties":false}]}},"is_enabled":{"type":"boolean","default":true},"created_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true},"updated_at":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","nullable":true}},"required":["name","agents","trigger","actions","is_enabled"],"id":"Workflow_Output","additionalProperties":false},"EnableDisable_Output":{"type":"object","properties":{"is_enabled":{"type":"boolean"}},"required":["is_enabled"],"id":"EnableDisable_Output","additionalProperties":false},"User":{"type":"object","properties":{"user_id":{"type":"number"},"account_id":{"type":"number"},"name":{"type":"string"},"email":{"type":"string"},"role":{"type":"string","enum":["Owner","Admin","Manager"]},"ip_address":{"type":"string","readOnly":true},"is_email_verified":{"type":"boolean"},"is_email_subscribed":{"type":"boolean"},"guid":{"type":"string","readOnly":true},"last_login_at":{"format":"date-time","type":"string"},"status":{"type":"string"},"avatar":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["email","role"]},"CustomSuccess":{"type":"object","properties":{}},"Object":{"type":"object","properties":{}}}},"security":[{"bearer":[]}]}