Inputs API

Inputs API is used to manage the input configuration of a particular agent. Use this API to add input URL, attach a list, or source agent reference in an agent input.

Get agent input by agent id

This API fetches the agent input by given agent id.

Endpoint:

Method: GET
URL: https://api.agenty.com/v2/inputs/{{AGENT_ID}}

Headers:

Query params:

Responses:

Status: OK | Code: 200

{
 "type":"url",
 "collection":1,
 "data":["https://raw.githubusercontent.com/Agenty/Agenty.TestData/master/scraping/json/json-objects-key-with-spaces.json"]
}

Attach a list in agent input

This API will attach a list to the given agent id.

Endpoint:

Method: PUT
URL: https://api.agenty.com/v2/inputs/{{AGENT_ID}}

Headers:

Query params:

Body:

{
 "type":"list",
 "id":"2436",
 "collection":1,
 "field":"url",
 "data":["https://raw.githubusercontent.com/Agenty/Agenty.TestData/master/scraping/json/json-objects-key-with-spaces.json"]
}

Responses:

Status: OK | Code: 200

{
  "status_code": 200,
  "message": "Input updated succesfully"
}

Attach source agent in agent input

This API will attach the source agent reference in input for the given agent id

Endpoint:

Method: PUT
URL: https://api.agenty.com/v2/inputs/{{AGENT_ID}}

Headers:

Query params:

Body:

{
 "type":"agent",
 "id":"gw2y79gvrk",
 "collection":1,
 "field":"URL",
 "data":["https://raw.githubusercontent.com/Agenty/Agenty.TestData/master/scraping/json/json-objects-key-with-spaces.json"]
}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "input updated successfully"
}

Attach manual urls in agent input

This API will overwrite the manual URLs in agent input.

Endpoint:

Method: PUT
URL: https://api.agenty.com/v2/inputs/{{AGENT_ID}}

Headers:

Query params:

Body:

{
 "type":"manual",
 "collection":1,
 "data":["https://raw.githubusercontent.com/Agenty/Agenty.TestData/master/scraping/json/json-objects-key-with-spaces.json"]
}

Responses:

Status: OK | Code: 200

{
    "status_code": 200,
    "message": "input updated successfully"
}