> ## Documentation Index
> Fetch the complete documentation index at: https://docs.beam.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Complete API reference for Beam AI platform integration and automation

Welcome to the Beam AI API documentation. This API allows you to programmatically interact with the Beam platform to create, manage, and execute AI agents.

## Base URL

All API requests should be made to:

```
https://api.beamstudio.ai
```

## Authentication

The Beam AI API uses API key authentication. You'll need to:

1. Include your API key in the `x-api-key` header
2. Include your `current-workspace-id` header for workspace-specific operations

Learn more in the [Authentication](/08-reference/api/authentication/authentication) section.

## Quick Start

Here's a simple example to get you started:

<CodeGroup>
  ```javascript JavaScript theme={null}
  const taskResponse = await fetch('https://api.beamstudio.ai/agent-tasks', {
    method: 'POST',
    headers: {
      'x-api-key': 'your-api-key',
      'current-workspace-id': 'your-workspace-id',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      agentId: 'agent_123456',
      input: { message: 'Hello, agent!' }
    })
  });
  const task = await taskResponse.json();
  ```

  ```python Python theme={null}
  import requests

  task_response = requests.post(
      'https://api.beamstudio.ai/agent-tasks',
      headers={
          'x-api-key': 'your-api-key',
          'current-workspace-id': 'your-workspace-id'
      },
      json={
          'agentId': 'agent_123456',
          'input': {'message': 'Hello, agent!'}
      }
  )
  task = task_response.json()
  ```
</CodeGroup>

## API Sections

### Users

Retrieve information about authenticated users and their workspaces.

* [Get Current User](/08-reference/api/users/get-user)

### Agents

List and manage AI agents in your workspace.

* [List Agents](/08-reference/api/agents/list-agents)

### Agent Graphs

Access agent workflow structures and configurations.

* [Get Agent Graph](/08-reference/api/agent-graphs/get-graph)

### Agent Tasks

Create, monitor, and analyze agent task executions.

* [Create Task](/08-reference/api/agent-tasks/create-task)
* [List Tasks](/08-reference/api/agent-tasks/list-tasks)
* [Get Analytics](/08-reference/api/agent-tasks/task-analytics)

## Error Handling

The API uses standard HTTP status codes:

* `200` - Success
* `201` - Created
* `400` - Bad Request (invalid parameters)
* `401` - Unauthorized (invalid or missing token)
* `403` - Forbidden (insufficient permissions)
* `404` - Not Found
* `500` - Internal Server Error

## Support

Need help with the API?

* Check our [documentation](/01-getting-started/welcome/welcome)
* Join our [Discord community](https://discord.gg/beam-ai)
* Contact support at [support@beam.ai](mailto:support@beam.ai)

## Changelog

Stay updated with the latest API changes in our [Changelog](/10-changelog/latest-updates/latest-updates).