# AgentsCode

> AgentsCode is an AI Agents API service that allows you to call high quality AI agents for development and automation purposes.

AgentsCode provides a platform for developers to integrate AI capabilities into their applications through a simple, developer-friendly API. The platform supports various agent types optimized for different tasks.

## Main Website Information

# AgentsCode

> AI Agents API Service that allows you to call high quality AI agents

AgentsCode provides a platform for developers to integrate AI capabilities into their applications through a simple, developer-friendly API. The platform supports various agent types optimized for different tasks.

## Key Features

- Simple API integration
- Multiple agent types for different use cases
- Scalable architecture
- Developer-friendly documentation
- Flexible pricing options


---

## Documentation

# AgentsCode API Reference

Welcome to the AgentsCode API. If you have any questions, please don't hesitate to reach out.

## Authentication

The AgentsCode API uses API keys to authenticate requests. You can manage your API keys from your Dashboard.

Authentication is done via an `Authorization` header:

```bash
Authorization: Bearer <API_KEY_HERE>
```

## Base URL

All API requests should be made to: <CopyToClipboard>https://api.agentscode.dev/v1</CopyToClipboard>

## Call an Agent

### The Agent Object

```json
{
  "id": "agent_123456",
  "name": "youtube-transcription",
  "displayName": "YouTube Transcription",
  "version": "1.0.0",
  "credits": 5,
  "description": "Transcribe YouTube videos to text",
  "status": "ACTIVE",
  "runCount": 42
}
```

### Available Agents

Retrieve all available agents for your account.

```http
GET /agents
```

<Hoppscotch id="HFzSRWZRU3Uo" />

<Terminal
  initialTab="cURL"
  tabs={[
    {
      name: "cURL",
      language: "bash",
      code:
`
curl --request GET \\
  --url https://api.agentscode.dev/v1/agents \\
  --header 'Authorization: Bearer <token_here>' \\
  --header 'content-type: application/json'
`
    },
    {
      name: "JavaScript",
      language: "javascript",
      code:
`
const url = 'https://api.agentscode.dev/v1/agents';
const options = {
  method: 'GET',
  headers: {'content-type': 'application/json', Authorization: 'Bearer <token_here>'},
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
`
    },
    {
      name: "Python",
      language: "python",
      code:
`
import requests

url = "https://api.agentscode.dev/v1/agents"

headers = {
  "content-type": "application/json",
  "Authorization": "Bearer <token_here>"
}

response = requests.get(url, headers=headers)

print(response.json())
`
    },
    {
      name: "n8n",
      language: "n8n",
      code: {
        "nodes": [
          {
            "parameters": {},
            "type": "n8n-nodes-base.manualTrigger",
            "typeVersion": 1,
            "position": [
              0,
              0
            ],
            "id": "56a58367-1c8f-49e7-9f67-6ba778e903ee",
            "name": "When clicking 'Test workflow'"
          },
          {
            "parameters": {
              "url": "https://api.agentscode.dev/v1/agents",
              "sendHeaders": true,
              "headerParameters": {
                "parameters": [
                  {
                    "name": "Authorization",
                    "value": "Bearer <token_here>"
                  }
                ]
              },
              "options": {}
            },
            "type": "n8n-nodes-base.httpRequest",
            "typeVersion": 4.2,
            "position": [
              180,
              0
            ],
            "id": "93431f29-1db7-4e9d-8ef3-d9cf00c526f6",
            "name": "HTTP Request"
          }
        ],
        "connections": {
          "When clicking 'Test workflow'": {
            "main": [
              [
                {
                  "node": "HTTP Request",
                  "type": "main",
                  "index": 0
                }
              ]
            ]
          }
        },
        "pinData": {},
      }
    }
  ]}
  />

```json
[
  {
    "id": "agent-name",
    "name": "Agent Name",
    "description": "Description of what the agent does",
    "version": "1.0.0",
    "credits": 5,
    "status": "ACTIVE"
  }
]
```

#### Response

Returns an array of agent objects.

### Run an Agent

Run an agent with specific input parameters.

```http
POST /agents/:agentId
```

<Hoppscotch id="KlobHTiF1WH9" />

<Terminal
  agentId="run-agent"
  initialTab="cURL"
  tabs={[
    {
      name: "cURL",
      language: "bash",
      code:
`
curl --request POST \\
  --url https://api.agentscode.dev/v1/agents/event-scheduler \\
  --header 'Authorization: Bearer <token_here>' \\
  --header 'content-type: application/json' \\
  --data '{
  "input": "Book a appointment for tomorrow with Jeff at 10am"
}'
`
    },
    {
      name: "JavaScript",
      language: "javascript",
      code:
`
const url = 'https://api.agentscode.dev/v1/agents/event-scheduler';
const options = {
  method: 'POST',
  headers: {'content-type': 'application/json', Authorization: 'Bearer <token_here>'},
  body: '{"input":"Book a appointment for tomorrow with Jeff at 10am"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
`
    },
    {
      name: "Python",
      language: "python",
      code:
`
import requests

url = "https://api.agentscode.dev/v1/agents/event-scheduler"

payload = { "input": "Book a appointment for tomorrow with Jeff at 10am" }
headers = {
  "content-type": "application/json",
  "Authorization": "Bearer <token_here>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
`
    },
    {
      name: "n8n",
      language: "n8n",
      code: {
        "nodes": [
          {
            "parameters": {},
            "type": "n8n-nodes-base.manualTrigger",
            "typeVersion": 1,
            "position": [
              0,
              0
            ],
            "id": "56a58367-1c8f-49e7-9f67-6ba778e903ee",
            "name": "When clicking 'Test workflow'"
          },
          {
            "parameters": {
              "method": "POST",
              "url": "https://api.agentscode.dev/v1/agents/event-scheduler",
              "sendHeaders": true,
              "headerParameters": {
                "parameters": [
                  {
                    "name": "Authorization",
                    "value": "Bearer <token_here>"
                  }
                ]
              },
              "sendBody": true,
              "bodyParameters": {
                "parameters": [
                  {
                    "name": "input",
                    "value": "Book a appointment for tomorrow with Jeff at 10am"
                  }
                ]
              },
              "options": {}
            },
            "type": "n8n-nodes-base.httpRequest",
            "typeVersion": 4.2,
            "position": [
              180,
              0
            ],
            "id": "93431f29-1db7-4e9d-8ef3-d9cf00c526f6",
            "name": "HTTP Request"
          }
        ],
        "connections": {
          "When clicking 'Test workflow'": {
            "main": [
              [
                {
                  "node": "HTTP Request",
                  "type": "main",
                  "index": 0
                }
              ]
            ]
          }
        },
        "pinData": {},
      }
    }
  ]}
/>

#### Parameters

<table>
  <thead>
    <tr>
      <th>Parameter</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>input</code></td>
      <td>object</td>
      <td>Required. Input parameters specific to the agent type</td>
    </tr>
    <tr>
      <td><code>contextData</code></td>
      <td>string</td>
      <td>Optional. Additional context for the agent</td>
    </tr>
  </tbody>
</table>

#### Response

```json
{
  "jobId": "ba773b85-af92-47bd-ad3h-c2r8b72n525j",
  "status": "queued"
}
```

## Get Agent Response

Get the response of an agent run.


```http
GET /agents/:agentId/:agentJobId
```

<Hoppscotch id="wwnKWGvUPViZ" />

<Terminal
  initialTab="cURL"
  tabs={[
    {
      name: "cURL",
      language: "bash",
      code:
`
curl --request GET \\
  --url https://api.agentscode.dev/v1/agents/event-scheduler/<agent_job_id> \\
  --header 'Authorization: Bearer <token_here>' \\
  --header 'content-type: application/json'
`
    },
    {
      name: "JavaScript",
      language: "javascript",
      code:
`
const url = 'https://api.agentscode.dev/v1/agents/event-scheduler/<agent_job_id>';
const options = {
  method: 'GET',
  headers: {'content-type': 'application/json', Authorization: 'Bearer <token_here>'},
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
`
    },
    {
      name: "Python",
      language: "python",
      code:
`
import requests

url = "https://api.agentscode.dev/v1/agents/event-scheduler/<agent_job_id>"

headers = {
  "content-type": "application/json",
  "Authorization": "Bearer <token_here>"
}

response = requests.get(url, headers=headers)

print(response.json())
`
    },
    {
      name: "n8n",
      language: "n8n",
      code: {
        "nodes": [
          {
            "parameters": {},
            "type": "n8n-nodes-base.manualTrigger",
            "typeVersion": 1,
            "position": [
              0,
              0
            ],
            "id": "56a58367-1c8f-49e7-9f67-6ba778e903ee",
            "name": "When clicking ‘Test workflow’"
          },
          {
            "parameters": {
              "url": "https://api.agentscode.dev/v1/agents/event-scheduler/<agent_job_id>",
              "sendHeaders": true,
              "headerParameters": {
                "parameters": [
                  {
                    "name": "Authorization",
                    "value": "Bearer <token_here>"
                  }
                ]
              },
              "options": {}
            },
            "type": "n8n-nodes-base.httpRequest",
            "typeVersion": 4.2,
            "position": [
              180,
              0
            ],
            "id": "80b3df6d-e852-4589-8e15-cbb8654b8571",
            "name": "HTTP Request"
          }
        ],
        "connections": {
          "When clicking ‘Test workflow’": {
            "main": [
              [
                {
                  "node": "HTTP Request",
                  "type": "main",
                  "index": 0
                }
              ]
            ]
          }
        },
        "pinData": {},
      }
    }
  ]}
/>

### Agent Run Object

```json
{
  "jobId": "ba773b85-af92-47bd-ad3h-c2r8b72n525j",
  "status": "completed",
  "progress": 100,
  "result": {...}
}
```

### Agent Status Values

Agents can have one of the following status values:

<table>
  <thead>
    <tr>
      <th>Status</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>queued</code></td>
      <td>The agent run has been accepted and is waiting to be processed</td>
    </tr>
    <tr>
      <td><code>active</code></td>
      <td>The agent is currently executing</td>
    </tr>
    <tr>
      <td><code>completed</code></td>
      <td>The agent has successfully completed its task</td>
    </tr>
    <tr>
      <td><code>failed</code></td>
      <td>The agent encountered an error and could not complete the task</td>
    </tr>
    <tr>
      <td><code>cancelled</code></td>
      <td>The agent run was cancelled by the user or the system</td>
    </tr>
  </tbody>
</table>

## Errors

The AgentsCode API uses HTTP response codes to indicate the success or failure of an API request.

<table>
  <thead>
    <tr>
      <th>Code</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>200</td>
      <td>Success</td>
    </tr>
    <tr>
      <td>400</td>
      <td>Bad Request - Invalid parameters</td>
    </tr>
    <tr>
      <td>401</td>
      <td>Unauthorized - Invalid API key</td>
    </tr>
    <tr>
      <td>404</td>
      <td>Not Found - Resource not found</td>
    </tr>
    <tr>
      <td>429</td>
      <td>Too Many Requests - Rate limit exceeded</td>
    </tr>
    <tr>
      <td>500</td>
      <td>Server Error - Something went wrong on our end</td>
    </tr>
  </tbody>
</table>

## Credits

Credits are consumed when running agents and when agents are ran successfully. You're only charged for successful runs.
Different agents require different amounts of credits.

### Credit Balance

Retrieve your current credit balance.

```http
GET /credits/balance
```

<Hoppscotch id="pyWBaE4reAJY" />

<Terminal
  initialTab="cURL"
  tabs={[
    {
      name: "cURL",
      language: "bash",
      code:
`
curl --request GET \\
  --url https://api.agentscode.dev/v1/credits/balance \\
  --header 'Authorization: Bearer <token_here>' \\
  --header 'content-type: application/json'
`
    },
    {
      name: "JavaScript",
      language: "javascript",
      code:
`
const url = 'https://api.agentscode.dev/v1/credits/balance';
const options = {
  method: 'GET',
  headers: {'content-type': 'application/json', Authorization: 'Bearer <token_here>'},
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
`
    },
    {
      name: "Python",
      language: "python",
      code:
`
import requests

url = "https://api.agentscode.dev/v1/credits/balance"

headers = {
  "content-type": "application/json",
  "Authorization": "Bearer <token_here>"
}

response = requests.get(url, headers=headers)

print(response.json())
`
    },
    {
      name: "n8n",
      language: "n8n",
      code: {
        "nodes": [
          {
            "parameters": {},
            "type": "n8n-nodes-base.manualTrigger",
            "typeVersion": 1,
            "position": [
              0,
              0
            ],
            "id": "56a58367-1c8f-49e7-9f67-6ba778e903ee",
            "name": "When clicking 'Test workflow'"
          },
          {
            "parameters": {
              "url": "https://api.agentscode.dev/v1/credits/balance",
              "sendHeaders": true,
              "headerParameters": {
                "parameters": [
                  {
                    "name": "Authorization",
                    "value": "Bearer <token_here>"
                  }
                ]
              },
              "sendBody": true,
              "bodyParameters": {
                "parameters": [
                  {}
                ]
              },
              "options": {}
            },
            "type": "n8n-nodes-base.httpRequest",
            "typeVersion": 4.2,
            "position": [
              180,
              0
            ],
            "id": "80b3df6d-e852-4589-8e15-cbb8654b8571",
            "name": "HTTP Request"
          }
        ],
        "connections": {
          "When clicking 'Test workflow'": {
            "main": [
              [
                {
                  "node": "HTTP Request",
                  "type": "main",
                  "index": 0
                }
              ]
            ]
          }
        },
        "pinData": {},
      }
    }
  ]}
/>

```json
{
  "available": 100,
  "used": 50
}
```

### Credit Usage History

Retrieve your credit usage history.

```http
GET /credits/history
```

<Hoppscotch id="ZKHhbZqUtyEV" />

<Terminal
  initialTab="cURL"
  tabs={[
    {
      name: "cURL",
      language: "bash",
      code:
`
curl --request GET \\
  --url https://api.agentscode.dev/v1/credits/history \\
  --header 'Authorization: Bearer <token_here>' \\
  --header 'content-type: application/json'
`
    },
    {
      name: "JavaScript",
      language: "javascript",
      code:
`
const url = 'https://api.agentscode.dev/v1/credits/history';
const options = {
  method: 'GET',
  headers: {'content-type': 'application/json', Authorization: 'Bearer <token_here>'},
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
`},
{
  name: "Python",
  language: "python",
  code:
`
import requests

url = "https://api.agentscode.dev/v1/credits/history"

headers = {
  "content-type": "application/json",
  "Authorization": "Bearer <token_here>"
}

response = requests.get(url, headers=headers)

print(response.json())
`
    },
    {
      name: "n8n",
      language: "n8n",
      code: {
        "nodes": [
          {
            "parameters": {},
            "type": "n8n-nodes-base.manualTrigger",
            "typeVersion": 1,
            "position": [
              0,
              0
            ],
            "id": "56a58367-1c8f-49e7-9f67-6ba778e903ee",
            "name": "When clicking 'Test workflow'"
          },
          {
            "parameters": {
              "url": "https://api.agentscode.dev/v1/credits/history",
              "sendHeaders": true,
              "headerParameters": {
                "parameters": [
                  {
                    "name": "Authorization",
                    "value": "Bearer <token_here>"
                  }
                ]
              },
              "sendBody": true,
              "bodyParameters": {
                "parameters": [
                  {}
                ]
              },
              "options": {}
            },
            "type": "n8n-nodes-base.httpRequest",
            "typeVersion": 4.2,
            "position": [
              180,
              0
            ],
            "id": "80b3df6d-e852-4589-8e15-cbb8654b8571",
            "name": "HTTP Request"
          }
        ],
        "connections": {
          "When clicking 'Test workflow'": {
            "main": [
              [
                {
            "node": "HTTP Request",
            "type": "main",
            "index": 0
          }
        ]
      ]
          }
        },
        "pinData": {},
      }
    }
  ]}
/>

#### Response Structure

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>runs</code></td>
      <td>array</td>
      <td>Array of run objects with credit usage details</td>
    </tr>
    <tr>
      <td><code>runs[].id</code></td>
      <td>string</td>
      <td>Unique identifier for the run</td>
    </tr>
    <tr>
      <td><code>runs[].agent</code></td>
      <td>string</td>
      <td>The type of agent used for this run</td>
    </tr>
    <tr>
      <td><code>runs[].creditsUsed</code></td>
      <td>number</td>
      <td>Number of credits consumed by this run</td>
    </tr>
    <tr>
      <td><code>runs[].startedAt</code></td>
      <td>string</td>
      <td>ISO timestamp when the run was initiated</td>
    </tr>
    <tr>
      <td><code>runs[].completedAt</code></td>
      <td>string</td>
      <td>ISO timestamp when the run completed</td>
    </tr>
    <tr>
      <td><code>runs[].duration</code></td>
      <td>number</td>
      <td>Duration of the run in seconds</td>
    </tr>
    <tr>
      <td><code>runs[].jobId</code></td>
      <td>string</td>
      <td>The job identifier for this run</td>
    </tr>
    <tr>
      <td><code>runs[].status</code></td>
      <td>string</td>
      <td>Current status of the run (see Agent Status Values)</td>
    </tr>
    <tr>
      <td><code>hasMore</code></td>
      <td>boolean</td>
      <td>Indicates if there are more results available</td>
    </tr>
    <tr>
      <td><code>nextCursor</code></td>
      <td>string</td>
      <td>Pagination cursor to use for fetching the next page of results</td>
    </tr>
  </tbody>
</table>

#### Example Response

```json
{
  "runs": [
    {
      "id": "cm9fd21dc000ovp62yilaf9kw",
      "agent": "youtube-transcript",
      "creditsUsed": 20,
      "startedAt": "2025-04-13T00:42:59.953Z",
      "completedAt": "2025-04-13T00:43:12.095Z",
      "duration": 10.142,
      "jobId": "a9c5f4e1-de05-4166-5aa4-6f97c518fa5c",
      "status": "completed"
    }
  ],
  "hasMore": true,
  "nextCursor": "cm9wt68c0i01brbmvg5t1d3a"
}
```


---

# Getting Started

Get started with AgentsCode in minutes

## Create an Account


1. Sign up for a new account [Sign Up](https://agentscode.dev/sign-up)
2. Verify your email address

## Get Your API Key

1. Log in to your [dashboard](https://agentscode.dev/dashboard)
2. Click **Create API Key**
3. Give your key a description like "Test Key"
4. Copy your API key - you won't be able to see it again!

## Install the SDK

(Coming Soon!)



## Need Help?

If you have any questions or run into issues:

- Join our [Discord Community](https://discord.gg/QB4U8J4Kc9)
- [Contact us](/contact)


---

## Additional Resources

# AgentsCode Pricing

> AgentsCode offers flexible pricing options for developers and businesses of all sizes.

## Pricing Plans

### Free Tier
- Limited API calls per month
- Basic agent capabilities
- Standard support

### Pro Plan
- Increased API call volume
- Advanced agent capabilities
- Priority support
- Custom integrations

### Enterprise
- Unlimited API calls
- Full suite of agent capabilities
- Dedicated support
- Custom development
- SLA guarantees


---

# Contact AgentsCode

> Get in touch with the AgentsCode team for questions, support, or partnership inquiries.
[Contact](https://agentscode.dev/contact)