A dev-first open source autonomous AI agent framework enabling developers to build, manage & run useful autonomous agents. You can run concurrent agents seamlessly, extend agent capabilities with tools. The agents efficiently perform a variety of tasks and continually improve their performance with each subsequent run.
\nTo use the key in your API call, pass it in the headers as shown below:
\nTo generate a new API key, navigate to the API Keys Dashboard on the Settings page in SuperAGI.
![](\"https://superagi.com/wp-content/uploads/2023/08/API_dashboard.png\")
\n Click on Create key and give a name for your API key.
![](\"https://superagi.com/wp-content/uploads/2023/08/create_api.png\")
\n Copy the key generated and click on OK.
![](\"https://superagi.com/wp-content/uploads/2023/08/OKay.png\")
\n You will be able to view, edit or delete your keys in your SuperAGI dashboard.
\n![](\"https://superagi.com/wp-content/uploads/2023/08/delete.png\")
Authentication to the SuperAGI API is performed by passing X-API-Key in headers.
X-API-Key: yoursuperagiapikey\n\nCloud baseurl\nhttps://app.superagi.com\nEg. On SuperAGI cloud, create agent API endpoint would look like\nhttps://app.superagi.com/api/v1/agent\n\nLocal baseurl\nhttp://localhost:3000\nEg. On SuperAGI local, create agent API endpoint would look like\nhttp://localhost:3000/api/v1/agent\n\nThis endpoint allows users to create agents
\nThis endpoint allows users to pause agent runs
\n","urlObject":{"path":["api","v1","agent","{agent_id}","pause"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"67a34561-8ba0-457f-971b-08d575facc8f","name":"Pause","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"bf2b13a0-c5d3-403f-a887-ac8849b8304b","type":"text"}],"body":{"mode":"raw","raw":"{\n \"run_ids\":[18]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/{agent_id}/pause"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Wed, 16 Aug 2023 14:04:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"success\"\n}"}],"_postman_id":"3377abbd-ca33-4b65-bcb5-e51dd60fe890"},{"name":"Resume","id":"319870f4-26c5-41ba-b4cf-72a458d45d6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"e3347a48-c4f0-4fcc-b444-7a375473c712","type":"text"}],"body":{"mode":"raw","raw":"{\n \"run_ids\":[98,100,102]\n} ","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/{agent_id}/resume","description":"This endpoint allows users to resume agent runs
\n","urlObject":{"path":["api","v1","agent","{agent_id}","resume"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"13c317dc-b0ee-456c-b40a-854fa409fb25","name":"Resume","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"bf2b13a0-c5d3-403f-a887-ac8849b8304b","type":"text"}],"body":{"mode":"raw","raw":"{\n \"run_ids\":[25]\n} ","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/{agent_id}/resume"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Wed, 16 Aug 2023 14:13:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": \"success\"\n}"}],"_postman_id":"319870f4-26c5-41ba-b4cf-72a458d45d6a"},{"name":"Update","id":"5d8b8958-0548-4a33-b6da-078eaa18fbc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"X-API-Key","value":"e3347a48-c4f0-4fcc-b444-7a375473c712","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Aug 17 0626\",\n \"description\": \"AI assistant to solve complex problems\",\n \"goal\": [\"compare iphone 15 and iphone 14 base variant\"],\n \"agent_workflow\": \"Don't Maintain Task Queue\", \n \"constraints\": [\n \"~4000 word limit for short term memory.\",\n \"Your short term memory is short, so immediately save important information to files.\",\n \"If you are unsure how you previously did something or want to recall past events, thinking about similar events will help you remember.\",\n \"No user assistance\",\n \"Exclusively use the commands listed in double quotes e.g. \\\"command name\\\"\"\n ],\n \"instruction\": [],\n \"tools\":[\n { \n \"name\":\"Image Generation Toolkit\"\n },\n { \n \"name\":\"DuckDuckGo Search Toolkit\"\n }\n ],\n \"iteration_interval\": 500,\n \"model\": \"gpt-4\",\n \"max_iterations\": 25\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/{agent_id}","description":"This endpoint allows users to update an existing agent.
\nNote:
\nUsers can't add schedule to an existing agent using the update end point.
\n","urlObject":{"path":["api","v1","agent","{agent_id}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"e447d97f-acba-4d74-bad8-a2e50c7a29f5","name":"Update","originalRequest":{"method":"PUT","header":[{"key":"X-API-Key","value":"c6c2a6b3-3bba-41eb-a031-c767a645e9e9","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"dasdas test_100dasdrreterterteasffffffffffffffffffffff1_updated\",\n \"org_id\": 1,\n \"description\": \"AI assistant to solve complex problems\",\n \"goal\": [\"compare iphone 15 and iphone 14 base variant\"],\n \"agent_workflow\": \"Don't Maintain Task Queue\", \n \"constraints\": [\n \"~4000 word limit for short term memory.\",\n \"Your short term memory is short, so immediately save important information to files.\",\n \"If you are unsure how you previously did something or want to recall past events, thinking about similar events will help you remember.\",\n \"No user assistance\",\n \"Exclusively use the commands listed in double quotes e.g. \\\"command name\\\"\"\n ],\n \"instruction\": [],\n \"tools\":[\n { \n \"name\":\"Image Generation Toolkit\"\n },\n { \n \"name\":\"DuckDuckGo Search Toolkit\"\n }\n ],\n \"iteration_interval\": 500,\n \"model\": \"gpt-4\",\n \"max_iterations\": 25\n // \"schedule\": { \n // \"start_time\": \"2023-07-07 06:15:00\",\n // \"recurrence_interval\": \"5 Minutes\",\n // \"expiry_runs\": 2,\n // \"expiry_date\": null\n // }\n\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/72"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Fri, 18 Aug 2023 05:55:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"agent_id\": 72\n}"}],"_postman_id":"5d8b8958-0548-4a33-b6da-078eaa18fbc9"}],"id":"c7ff5722-b3c0-4824-8fe0-e16d0fe1fef1","description":"Agents in SuperAGI are complex systems that leverage the power of LLMs to operate independently, reason, perform tasks, and takes decisions without the constant need for human intervention.
\nThe Agents, plan, reason, interact with toolkits, and execute based on the user's Goals, Instructions, Resources, and Constraints to achieve the expected results.
\n","_postman_id":"c7ff5722-b3c0-4824-8fe0-e16d0fe1fef1"},{"name":"Run","item":[{"name":"Create","id":"e2d5f1ef-d77f-46a3-bbf4-f0a364c6f2a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"776022a2-159e-40b5-8bd6-d733de2ade98","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/{agent_id}/run","description":"This endpoint allows users to create an agent run
\n","urlObject":{"path":["api","v1","agent","{agent_id}","run"],"host":["{{URL}}"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"036f1a50-3e46-4cf1-ab02-eaef9c7fbdaf","name":"Create","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"bf2b13a0-c5d3-403f-a887-ac8849b8304b","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{URL}}/api/v1/agent/{agent_id}/run","host":["{{URL}}"],"path":["api","v1","agent","{agent_id}","run"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Wed, 16 Aug 2023 14:14:13 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"13"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"run_id\": 40\n}"}],"_postman_id":"e2d5f1ef-d77f-46a3-bbf4-f0a364c6f2a0"},{"name":"Retrieve Agent Runs","id":"9ace0499-023c-4738-8a41-1e8082deb935","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"e3347a48-c4f0-4fcc-b444-7a375473c712","type":"text"}],"body":{"mode":"raw","raw":"{\n \"run_status_filter\":\"RUNNING\" // run_status_filter could be values like RUNNING, PAUSED, COMPLETED\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/{agent_id}/run-status","description":"This endpoint allows users to retrieve an agent runs
\n","urlObject":{"path":["api","v1","agent","{agent_id}","run-status"],"host":["{{URL}}"],"query":[{"disabled":true,"key":"run_ids","value":"[78,79]"}],"variable":[]}},"response":[{"id":"d2487715-9a18-4b8e-a202-ccc700435ab9","name":"Retrieve Agent Runs","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"bf2b13a0-c5d3-403f-a887-ac8849b8304b","type":"text"}],"body":{"mode":"raw","raw":"{\n \"run_status_filter\":\"RUNNING\" // run_status_filter could be values like RUNNING, PAUSED, COMPLETED\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{URL}}/api/v1/agent/{agent_id}/run-status","host":["{{URL}}"],"path":["api","v1","agent","{agent_id}","run-status"],"query":[{"key":"run_ids","value":"[78,79]","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Wed, 16 Aug 2023 14:05:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"34"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"run_id\": 39,\n \"status\": \"RUNNING\"\n }\n]"}],"_postman_id":"9ace0499-023c-4738-8a41-1e8082deb935"}],"id":"a8899f37-c6c1-466a-8869-3873aefc7545","description":"An agent run is the end-to-end execution of the goals and instructions that has been assigned to the agent, operating within the set constraints with the necessary tools and resources.
\n","_postman_id":"a8899f37-c6c1-466a-8869-3873aefc7545"},{"name":"Resources","item":[{"name":"Retrieve Run Resources","id":"4bc2a1e9-7c2c-4d0d-b34b-7241500a738b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-API-Key","value":"426436df-e4cb-428d-af9f-65b162d3ada3","type":"text"}],"body":{"mode":"raw","raw":"{\n \"run_ids\":[97,98,99,100,101,102]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/resources/output","description":"This endpoint allows users to retrieve resources of an agent run
\n","urlObject":{"path":["api","v1","agent","resources","output"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"2ce9cccd-c440-4a4e-b17e-0f08d1bd232c","name":"Get Run Resources","originalRequest":{"method":"POST","header":[{"key":"X-API-Key","value":"bf2b13a0-c5d3-403f-a887-ac8849b8304b","type":"text"}],"body":{"mode":"raw","raw":"{\n \"run_ids\":[38]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}/api/v1/agent/resources/output"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Wed, 16 Aug 2023 14:15:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"99"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"38\": [\n \"https://superagi-instagram-tool.s3.amazonaws.com/public_resources/run_id38/cat_image_running.png\",\n \"https://superagi-instagram-tool.s3.amazonaws.com/public_resources/run_id38/cat_image_jumping.png\"\n ],\n \"39\": [\n \"https://superagi-instagram-tool.s3.amazonaws.com/public_resources/run_id38/cat_image_small.png\"\n ]\n}"}],"_postman_id":"4bc2a1e9-7c2c-4d0d-b34b-7241500a738b"}],"id":"c4fa8892-ba9d-4bd1-b4cf-2c78896a016c","description":"Resources are the input/output files used or generated by the agent during its run.
\n","_postman_id":"c4fa8892-ba9d-4bd1-b4cf-2c78896a016c"}],"variable":[{"key":"API_KEY","value":"856ab32f-72e5-4d19-8672-f6adb3f0647f"},{"key":"agent_id","value":"2"}]}