Agenty API

Welcome to Agenty for Developers! Just like you, we are enthusiastic web developers and we love to automate things. With Agenty we are building hundreds of automative agents to extract, clean, translate, validate and OCR the big data for machine intelligence. And we know that one of the best way to do that, is to give you the ability to have the hands on your agents and data from any programming language. Please find below, the full REST API documentation and references in order to reach this goal.


The root endpoint of Agenty API is: and we recommend you to fetch our API over https.


In order to start using API, you need an Agenty account. Signup here, if you don’t have one.

Once you are logged in, go to the Settings page and then API keys page to get your API key token to start using the API.

We use keys to allow access and in order to authorize API requests. Just add your api key token as query parameter to each API requests apikey=xxxxxxx

Alternatively, you can also add a header as X-Agenty-ApiKey : {Your Key Here} on each requests to get authenticated.

API References

Name Reference
Agents API Get all agents
Get agent by agent id
Clone agent by id
Delete agent by id
Scraping Agent API Create a scraping agent
Get scraping agent by id
Update a scraping agent
Jobs API Start a job
Stop a running job
Get job status by job id
Get job result by job id
Get job logs by job id
Export job result by job id
Get all jobs
Get jobs by agent id
Scheduler API Schedule the agent
Delete the schedule
Inputs API Get agent input by agent id
Attach a list in agent input
Attach source agent in agent input
Attach manual urls in agent input
Lists API Create a List
Get List by id
Update a List by id
Get all Lists
Delete List by id
Buckets API Create a bucket
Get bucket by id
Update bucket by id
Get all buckets
Delete bucket by id
Team API Add a new team member
Get team member by id
Update team member by id
Get all team members
Delete team member by id
Roles API Create a new role
Get role by id
Update role by id
Get all roles
Delete role by id
Roles API Create a new api key
Reset api key by id
Get api key by id
Update api key by id
Get all api keys
Delete api key by id