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

# Apify: Get Actor

> Get an Apify actor's details, such as its description, author, versions and stats, by its ID or name. Includes SDK V2 examples, schemas, and cost.

Get an Apify actor's details, such as its description, author, versions and stats, by its ID or name.

> [!NOTE]
>
> Tool ID: `apify_get_actor`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apify_get_actor',
  {
    "actorId": "actor_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute apify_get_actor --input '{
  "actorId": "actor_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "status": "example",
  "result": {
    "data": {
      "data": {
        "id": "id_123",
        "name": "Example",
        "username": "user@example.com",
        "title": "VP of Engineering",
        "description": "Example description",
        "isPublic": true,
        "categories": [
          "example"
        ]
      }
    },
    "meta": {
      "status": 123
    }
  }
}
```

Use `deepline describe apify_get_actor --json` for the latest machine-readable contract.

## Input reference

Apify get actor input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.actorId` | `string` | Yes | — | — |
| `payload.params` | `record` | No | — | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Apify get actor input.",
    "properties": {
      "actorId": {
        "type": "string"
      },
      "params": {
        "type": "object",
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            }
          ]
        }
      }
    },
    "required": [
      "actorId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.data` | `object` | Yes | — | — |
| `result.result.data.data` | `object` | Yes | — | — |
| `result.result.data.data.id` | `string` | Yes | — | — |
| `result.result.data.data.name` | `string` | Yes | — | — |
| `result.result.data.data.username` | `string` | Yes | — | — |
| `result.result.data.data.title` | `string` | Yes | — | — |
| `result.result.data.data.description` | `string` | Yes | — | — |
| `result.result.data.data.isPublic` | `boolean` | Yes | — | — |
| `result.result.data.data.categories` | `array` | Yes | — | — |
| `result.result.meta` | `object` | Yes | — | — |
| `result.result.meta.status` | `integer` | Yes | — | — |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "username": {
                    "type": "string"
                  },
                  "title": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "isPublic": {
                    "type": "boolean"
                  },
                  "categories": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "id",
                  "name",
                  "username",
                  "title",
                  "description",
                  "isPublic",
                  "categories"
                ],
                "additionalProperties": true
              }
            },
            "required": [
              "data"
            ],
            "additionalProperties": true
          },
          "meta": {
            "type": "object",
            "properties": {
              "status": {
                "type": "integer"
              }
            },
            "required": [
              "status"
            ],
            "additionalProperties": true
          }
        },
        "required": [
          "data",
          "meta"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Apify provider guide](https://deepline.com/docs/providers/apify/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.