Create an agent

1 curl -X POST "https://api.x.flatfile.com/v1/agents?environmentId=us_env_YOUR_ID" \ 2 -H "X-Disable-Hooks: true" \ 3 -H "Authorization: Bearer <token>" \ 4 -H "Content-Type: application/json" \ 5 -d '{ 6 "topics": [ 7 "workbook:updated" 8 ], 9 "compiler": "js", 10 "source": "module.exports = { routeEvent: async (...args) => { console.log(args) } }", 11 "options": { 12 "namespace": "space:blue" 13 } 14 }'

1 { 2 "data": { 3 "accountId": "us_acc_YOUR_ID", 4 "createdAt": "2023-10-30T16:59:45.735Z", 5 "environmentId": "us_env_YOUR_ID", 6 "id": "us_ag_YOUR_ID", 7 "updatedAt": "2023-10-30T16:59:45.735Z", 8 "compiler": "js", 9 "options": { 10 "namespace": "space:blue" 11 }, 12 "slug": "default", 13 "source": "module.exports = { routeEvent: async (...args) => { console.log(args) } }", 14 "topics": [ 15 "workbook:updated" 16 ] 17 } 18 }

Query parameters

environmentIdstringRequired

Environment ID

Request

This endpoint expects an object.

topicslist of enumsOptional

The topics the agent should listen for

compilerenumOptional

The compiler of the agent

Allowed values:

sourcestringOptional

The source of the agent

sourceMapstringOptional

The source map of the agent

slugstringOptional

The slug of the agent

optionsmap from strings to anyOptional

Options for the agent

isSystembooleanOptional

Whether the agent is a system agent. This should be false for all agents created by users.

namespacestringOptional

The namespace this agent should be limited to. Right now, this is information only and not used to actually filter agents that run, so you must still specify the namespace filter in the agent code.

Response

This endpoint returns an object.

dataobjectOptional

Headers

Query parameters

Request

Response

Errors