> ## 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 Input Schema

> Get the input fields, types and defaults an Apify actor accepts, so you can build its input before running it. Includes SDK V2 examples, schemas, and cost.

Get the input fields, types and defaults an Apify actor accepts, so you can build its input before running it.

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

## 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_input_schema',
  {
    "actorId": "actor_123"
  },
);

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

### CLI

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

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe apify_get_actor_input_schema --json` for the complete live contract.

## Input reference

Apify get actor input schema page input.

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

<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 schema page input.",
    "properties": {
      "actorId": {
        "type": "string"
      }
    },
    "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.title` | `string` | Yes | — | — |
| `result.result.data.type` | `string` | Yes | — | — |
| `result.result.data.properties` | `object` | Yes | — | — |
| `result.result.data.properties.urls` | `object` | Yes | — | — |
| `result.result.data.properties.urls.type` | `string` | Yes | — | — |
| `result.result.data.properties.urls.items` | `object` | Yes | — | — |
| `result.result.data.properties.urls.items.type` | `string` | Yes | — | — |
| `result.result.data.required` | `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": {
              "title": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "properties": {
                "type": "object",
                "properties": {
                  "urls": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string"
                      },
                      "items": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "type"
                        ],
                        "additionalProperties": true
                      }
                    },
                    "required": [
                      "type",
                      "items"
                    ],
                    "additionalProperties": true
                  }
                },
                "required": [
                  "urls"
                ],
                "additionalProperties": true
              },
              "required": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "title",
              "type",
              "properties",
              "required"
            ],
            "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.