> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Get an agent

GET https://api.cloudraker.com/v1/agents/{id}

Returns one agent: its steps, the actions it may take, their approval gates, and the `version` a new run will snapshot.

Read this before starting a run to know which steps will come back to you as human work, and which actions will ask for a sign-off.

<Note>
An agent's `id` is opaque — treat it as a string and do not parse it.
</Note>

**Learn more:** [Agents guide](https://docs.cloudraker.com/capabilities/agents)

Reference: https://docs.cloudraker.com/api/cloud-raker-api/agents/get-agent

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /v1/agents/{id}:
    get:
      operationId: get-agent
      summary: Get an agent
      description: >-
        Returns one agent: its steps, the actions it may take, their approval
        gates, and the `version` a new run will snapshot.


        Read this before starting a run to know which steps will come back to
        you as human work, and which actions will ask for a sign-off.


        <Note>

        An agent's `id` is opaque — treat it as a string and do not parse it.

        </Note>


        **Learn more:** [Agents
        guide](https://docs.cloudraker.com/capabilities/agents)
      tags:
        - agents
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Agent'
        '404':
          description: Unknown agent id, or an agent that is not active.
          content:
            application/json:
              schema:
                description: Any type
        '429':
          description: >-
            Rate limited. The `/v1` API allows at least **67 requests per minute
            per organization** (about 1,000 requests per 15 minutes) — a
            guaranteed floor, enforced per edge location, so a geographically
            spread caller may get more. Wait for the `Retry-After` interval and
            retry — the error is `retryable`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAgentRequestTooManyRequestsError'
servers:
  - url: https://api.cloudraker.com
    description: Production
  - url: https://api.staging.raker.one
    description: Staging
  - url: https://api.dev.raker.one
    description: Development
components:
  schemas:
    V1AgentTaskExecutor:
      type: string
      enum:
        - agent
        - human
      description: >-
        Who performs the step: `agent` runs by itself, `human` waits for a
        person to complete it.
      title: V1AgentTaskExecutor
    V1AgentTask:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        executor:
          $ref: '#/components/schemas/V1AgentTaskExecutor'
          description: >-
            Who performs the step: `agent` runs by itself, `human` waits for a
            person to complete it.
        dependsOn:
          type: array
          items:
            type: string
      required:
        - id
        - title
        - executor
        - dependsOn
      title: V1AgentTask
    V1AgentActionApproval:
      type: string
      enum:
        - auto
        - before
        - output
        - both
      description: |-
        When a person has to sign off on this step.

        - `auto` — no sign-off.
        - `before` — approve the proposed inputs before it runs.
        - `output` — approve the result before it is used.
        - `both` — both gates.
      title: V1AgentActionApproval
    V1AgentAction:
      type: object
      properties:
        name:
          type:
            - string
            - 'null'
        approval:
          $ref: '#/components/schemas/V1AgentActionApproval'
          description: |-
            When a person has to sign off on this step.

            - `auto` — no sign-off.
            - `before` — approve the proposed inputs before it runs.
            - `output` — approve the result before it is used.
            - `both` — both gates.
      required:
        - name
        - approval
      title: V1AgentAction
    V1Agent:
      type: object
      properties:
        object:
          type: string
          enum:
            - agent
        id:
          type: string
        name:
          type: string
        description:
          type: string
        version:
          type: number
          format: double
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/V1AgentTask'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/V1AgentAction'
        updatedAt:
          type: string
      required:
        - object
        - id
        - name
        - description
        - version
        - tasks
        - actions
        - updatedAt
      title: V1Agent
    V1AgentsIdGetResponsesContentApplicationJsonSchemaCode:
      type: string
      enum:
        - rate_limited
      title: V1AgentsIdGetResponsesContentApplicationJsonSchemaCode
    GetAgentRequestTooManyRequestsError:
      type: object
      properties:
        code:
          $ref: >-
            #/components/schemas/V1AgentsIdGetResponsesContentApplicationJsonSchemaCode
        message:
          type: string
        retryable:
          type: boolean
        requestId:
          type: string
        docUrl:
          type: string
      required:
        - code
        - message
        - retryable
        - requestId
      title: GetAgentRequestTooManyRequestsError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "object": "agent",
  "id": "ag_9f8b7c6d5e4a3b2c1d0e",
  "name": "Customer Support Automation",
  "description": "Automates initial customer support ticket triage and routing.",
  "version": 3.4,
  "tasks": [
    {
      "id": "task-1",
      "title": "Analyze incoming ticket",
      "executor": "agent",
      "dependsOn": []
    },
    {
      "id": "task-2",
      "title": "Assign priority level",
      "executor": "agent",
      "dependsOn": [
        "task-1"
      ]
    },
    {
      "id": "task-3",
      "title": "Human review for escalation",
      "executor": "human",
      "dependsOn": [
        "task-2"
      ]
    }
  ],
  "actions": [
    {
      "name": "Send notification email",
      "approval": "auto"
    },
    {
      "name": "Escalate to manager",
      "approval": "before"
    }
  ],
  "updatedAt": "2024-06-10T09:45:00Z"
}
```

**SDK Code**

```typescript
import { CloudRakerClient } from "@cloudraker/api";

async function main() {
    const client = new CloudRakerClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.agents.getAgent("id");
}
main();

```

```python
from cloudraker import CloudRaker

client = CloudRaker(
    token="YOUR_TOKEN_HERE",
)

client.agents.get_agent(
    id="id",
)

```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/v1/agents/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/v1/agents/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.cloudraker.com/v1/agents/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.cloudraker.com/v1/agents/id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/agents/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/agents/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```