Skip to main content
GET
/
v0
/
agents
List agents
curl --request GET \
  --url https://cloud.firebender.com/v0/agents \
  --header 'X-API-Key: <api-key>'
{
  "agents": [
    {
      "id": "fb_abc123xyz789",
      "name": "Add README Documentation",
      "status": "CREATING",
      "source": {
        "repository": "https://github.com/your-org/your-repo",
        "ref": "main"
      },
      "target": {
        "url": "https://firebender.com/agents?id=fb_abc123xyz789",
        "branchName": "firebender/abc123xyz789",
        "prUrl": "https://github.com/your-org/your-repo/pull/1234",
        "autoCreatePr": false
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "summary": "Added README.md with installation instructions and usage examples"
    }
  ],
  "nextCursor": "fb_def456ghi789"
}

Authorizations

X-API-Key
string
header
required

API key from Firebender Dashboard

Query Parameters

limit
integer
default:20

Number of cloud agents to return (max 100)

Required range: 1 <= x <= 100
cursor
string

Pagination cursor from the previous response

Minimum string length: 1
Example:

"fb_xyz789abc123"

Response

Agents retrieved successfully

agents
object[]
required

List of agents

nextCursor
string

Cursor for fetching the next page of results

Example:

"fb_def456ghi789"